Referencia de la API
Crear o actualizar contacto
Crea un contacto. Si ya existe, lo actualiza; el nombre solo se reemplaza si el actual es un marcador, como el número de teléfono.
POST/api-create-contact
En esta página
Solicitud#
POSThttps://api.comdig.co/v1/api-create-contact
Permiso requerido: contacts:create
Parámetros del cuerpo#
| Nombre | Tipo | Requerido | Descripción |
|---|---|---|---|
phone | string | Sí | Teléfono en formato E.164. |
name | string | No | Nombre del contacto. |
email | string | No | Correo del contacto. |
channel_type | string | No | Canal del contacto.Por defecto: whatsapp |
Ejemplo#
curl -X POST "https://api.comdig.co/v1/api-create-contact" \
-H "X-API-Key: $COMDIG_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"phone": "+573001234567",
"name": "Ana Gómez",
"email": "ana@ejemplo.com"
}'Respuestas#
200Contacto creado o actualizado. created indica si es nuevo.
JSON
{
"success": true,
"contact_id": "1d2e3f4a-5b6c-7d8e-9f01-a2b3c4d5e6f7",
"created": true,
"contact": {
"id": "1d2e3f4a-5b6c-7d8e-9f01-a2b3c4d5e6f7",
"name": "Ana Gómez",
"phone": "+573001234567",
"email": "ana@ejemplo.com",
"channel_type": "whatsapp"
}
}409El contacto fue eliminado antes.
JSON
{
"error": "contact_was_deleted",
"message": "Este contacto fue eliminado previamente. Restáuralo desde la lista de contactos para reutilizarlo.",
"deleted_contact_id": "1d2e3f4a-5b6c-7d8e-9f01-a2b3c4d5e6f7"
}