Criar contato
POST/contacts
Cria 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.
Request
Responses
- 200
- 201
- 401
- 402
- 403
- 409
- 422
- 429
Contato existente atualizado (só com upsert=true).
Contato criado.
Token ausente, malformado, desconhecido ou revogado (authentication), ou
conta suspensa (tenant_inactive).
Sem direito de uso (payment_required). O corpo traz o motivo em reason e a saída
em action: o que fazer (kind) e a página do painel onde se faz (url).
O recurso informado não pertence à sua conta (forbidden), ou o caminho está
na lista de bloqueio do espelho (forbidden_endpoint), ou a sua API key é restrita a
alguns números e a operação é da conta inteira (forbidden).
contact_exists (o telefone ou BSUID já é de outro contato, com contactId) ou contact_limit_reached (o plano chegou ao teto de contatos, com limit e plan).
Payload reprovado na validação (invalid_request, com o detalhamento em
issues) ou recusado pela Meta (meta_error, com o corpo original em
meta).
Limite de requisições excedido (rate_limit).
Response Headers
Segundos a aguardar antes de tentar de novo.
Categoria do limite aplicada — send, media ou default.
Qual balde os outros headers descrevem — key (a API key), session (o painel) ou account (o teto da conta).
Teto de requisições da categoria na janela atual.
Requisições restantes na janela atual.