Criar contato
https://api.joinotify.com/contactsCria um contato a partir de um telefone ou de um BSUID. O telefone é normalizado para
E.164 e guardado sem o +; sem código de país, informe defaultCountry.
Com ?upsert=true, um contato que já existe é atualizado em vez de responder 409 —
e aí a resposta é 200, optIn é ignorado e tagIds substitui as tags. Mande
optIn com a evidência do consentimento para criar o contato já apto a receber marketing.
Uma API key restrita a alguns números recebe 403: esta operação é da base inteira.
Query Params
1 opcional(is)
Atualiza o contato quando ele já existe, em vez de responder 409.
Valores aceitos:true
Body Paramsapplication/json
1 condicional(is)10 opcional(is)
Regra: Informe phone ou bsuid — pelo menos um dos dois.
Telefone em formato internacional. Sem código de país, use defaultCountry.
máx. 40 caracteresaceita null
Id do usuário na Meta para a empresa (BSUID), no formato BR.abc123. Use quando não houver telefone.
máx. 160 caracteresaceita null
Obrigatório quando `phone` vem sem o código do país.
País (ISO 3166-1 alfa-2) para ler um telefone sem código de país.
exatamente 2 caracteres
Nome, até 80 caracteres.
máx. 80 caracteresaceita null
Sobrenome, até 80 caracteres.
máx. 80 caracteresaceita null
E-mail do contato, gravado em minúsculas.
máx. 254 caracteresaceita null
Idioma, como pt ou pt-BR.
aceita nullformato ^[a-z]{2}(-[A-Z]{2})?$
Fuso horário IANA.
máx. 64 caracteresaceita null
Patch nos campos personalizados. null ou "" apagam o valor; o formato é validado pelo tipo do campo.
Ids das tags. Na edição, é o conjunto completo.
até 50 itens
Só na criação: registra o consentimento de marketing já no cadastro.