Pular para o conteúdo principal
POST

Descrição

Cria um cliente de WhatsApp em um canal de produção da sua empresa, sem iniciar uma conversa. O cliente aparece em Clientes.
  • Só cria clientes de WhatsApp.
  • O cliente fica sem conversa: nenhuma mensagem é enviada.
  • Se o celular já é cliente desse canal, não é alterado: a resposta é 409 com o cliente existente.
  • As etiquetas enviadas são adicionadas à conversa do cliente nesse canal.

Endpoint

Antes de começar

1

Crie uma API key com a permissão Criar clientes

Em Configurações → API Keys, crie uma chave e marque Clientes → Criar clientes (clients:write). Consulte API Keys.
2

Obtenha o botId do canal de WhatsApp

O botId é o referenceId do canal. Você pode vê-lo com o CLI da Jelou:
O canal deve estar em produção, não em sandbox, e ter um projeto.
O botId não é o número de telefone do canal. Se você enviar o número, a resposta é 404 (CLIENT_BOT_NOT_ELIGIBLE).
3

Obtenha os IDs das etiquetas (opcional)

Para adicionar etiquetas, consulte os IDs em Gestão de etiquetas. Esse endpoint usa autenticação Basic (clientId:clientSecret), não a API key.

Parâmetros do corpo

string
obrigatório
Nome do cliente, de 1 a 191 caracteres. Os espaços no início e no fim são removidos.
string
obrigatório
Identificador do canal de WhatsApp onde o cliente é criado (o seu referenceId). Não é o número de telefone do canal.
string
obrigatório
Celular com código do país, por exemplo +593991234567. Aceita espaços, hífens, pontos e parênteses; não aceita letras.
integer[]
IDs numéricos de etiquetas da sua empresa, no máximo 50 (por exemplo [12, 13]). Não aceita nomes de etiquetas. Devem existir e estar ativas.

Autenticação

Envie o cabeçalho x-api-key com uma API key que tenha a permissão Criar clientes (clients:write).
string
obrigatório
API key da sua empresa com a permissão clients:write.
A API de clientes está sendo habilitada por empresa. Se a sua empresa ainda não a tem, a resposta é 403 com o erro CLIENTS_API_NOT_ENABLED.

Limite de uso

Até 60 requisições por minuto por empresa. Ao ultrapassar, a resposta é 429 e o cabeçalho Retry-After indica quantos segundos esperar.

Respostas

Nos erros, error.key identifica o caso e error.clientMessages traz uma mensagem para exibir em espanhol, inglês e português. No painel de exemplos está a resposta completa de cada caso.
Na resposta 409 de um cliente existente, tags vem vazio: as etiquetas não são consultadas nem alteradas.Em tags, name traz o nome por idioma como está configurado na etiqueta: só os idiomas que ela tem, e algum pode vir vazio.