Saltar al contenido principal
POST

Descripción

Crea un cliente de WhatsApp en un canal de producción de tu compañía, sin iniciar una conversación. El cliente aparece en Clientes.
  • Solo crea clientes de WhatsApp.
  • El cliente queda sin conversación: no se le envía ningún mensaje.
  • Si el celular ya es cliente de ese canal, no se modifica: la respuesta es 409 con el cliente existente.
  • Las etiquetas que envíes se agregan a la conversación del cliente en ese canal.

Endpoint

Antes de empezar

1

Crea una clave API con el permiso Crear clientes

En Configuración → Claves API, crea una clave y marca Clientes → Crear clientes (clients:write). Consulta Claves API.
2

Obtén el botId del canal de WhatsApp

El botId es el referenceId del canal. Puedes verlo con el CLI de Jelou:
El canal debe estar en producción, no en sandbox, y tener un proyecto.
El botId no es el número de teléfono del canal. Si envías el número, la respuesta es 404 (CLIENT_BOT_NOT_ELIGIBLE).
3

Obtén los IDs de las etiquetas (opcional)

Si quieres agregar etiquetas, consulta sus IDs en Gestión de etiquetas. Ese endpoint usa autenticación Basic (clientId:clientSecret), no la clave API.

Parámetros del cuerpo

string
requerido
Nombre del cliente, de 1 a 191 caracteres. Se quitan los espacios al inicio y al final.
string
requerido
Identificador del canal de WhatsApp donde se crea el cliente (su referenceId). No es el número de teléfono del canal.
string
requerido
Celular con código de país, por ejemplo +593991234567. Acepta espacios, guiones, puntos y paréntesis; no acepta letras.
integer[]
IDs numéricos de etiquetas de tu compañía, máximo 50 (por ejemplo [12, 13]). No acepta nombres de etiquetas. Deben existir y estar activas.

Autenticación

Envía el encabezado x-api-key con una clave API que tenga el permiso Crear clientes (clients:write).
string
requerido
Clave API de tu compañía con el permiso clients:write.
La API de clientes se está habilitando por compañía. Si tu compañía todavía no la tiene, la respuesta es 403 con el error CLIENTS_API_NOT_ENABLED.

Límite de uso

Hasta 60 solicitudes por minuto por compañía. Al superarlo, la respuesta es 429 y el encabezado Retry-After indica cuántos segundos esperar.

Respuestas

En los errores, error.key identifica el caso y error.clientMessages trae un mensaje para mostrar en español, inglés y portugués. En el panel de ejemplos tienes la respuesta completa de cada caso.
En la respuesta 409 de un cliente existente, tags viene vacío: las etiquetas no se consultan ni se modifican.En tags, name trae el nombre por idioma tal como está configurado en la etiqueta: solo los idiomas que tiene, y alguno puede venir vacío.