Skip to main content
Crea un contacto asociado a un inbox. Es obligatorio indicar al menos el inbox y recomendable nombre o email/teléfono.

​
Autenticación

​
api_access_token
string
required
Token de usuario (userApiKey).

​
Parámetros de ruta

​
account_id
integer
required
ID de la cuenta.

​
Cuerpo de la solicitud

​
inbox_id
number
required
ID del inbox al que pertenece el contacto. Ejemplo: 1.
​
name
string
Nombre del contacto. Ejemplo: Alice.
​
email
string
Email del contacto. Ejemplo: alice@acme.inc.
​
phone_number
string
Teléfono. Ejemplo: +123456789.
​
identifier
string
Identificador único en un sistema externo. Ejemplo: 1234567890.
​
blocked
boolean
Si el contacto está bloqueado. Por defecto false.
​
avatar_url
string
URL de avatar (JPEG/PNG). Alternativa a enviar avatar como binario.
​
additional_attributes
object
Objeto libre para atributos adicionales. Ej: {"type":"customer", "age":30}.
​
custom_attributes
object
Atributos que deben existir como definiciones de atributos personalizados en la cuenta.

​
Ejemplo de solicitud

curl -X POST 'https://app.yampi.ai/api/v1/accounts/1/contacts' \
  -H 'api_access_token: TU_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{
    "inbox_id": 1,
    "name": "Alice",
    "email": "alice@acme.inc",
    "phone_number": "+57300123456",
    "identifier": "cliente-001"
  }'

​
Respuesta exitosa

{
  "id": 10,
  "name": "Alice",
  "email": "alice@acme.inc",
  "phone_number": "+57300123456",
  "identifier": "cliente-001",
  "thumbnail": null,
  "blocked": false,
  "custom_attributes": {},
  "contact_inboxes": [],
  "additional_attributes": {}
}
​
id
number
required
ID del contacto creado.
​
contact_inboxes
array
Inboxes asociados al contacto.

​
Errores

  • 400: Bad Request — por ejemplo inbox_id inválido o datos incompletos.
  • 401: No autenticado.