Contactos

Un contacto es la persona con la que tu negocio conversa por WhatsApp, identificada por phone o whatsapp_id.

Un contacto es la persona con la que tu negocio conversa por WhatsApp, identificada por phone o whatsapp_id. Su ficha reúne nombre, email, país, notas, campos personalizados, asesor asignado (adviser_id), el número que lo atiende (device_id) y su lead_score. Se relaciona con etiquetas, etapas de tableros, flujos y difusiones. Para sincronizar tu CRM sin duplicados, empezá por Crear o actualizar un contacto.

Endpoints

Listar contactos

GET /api/v1/contacts · Usalo para buscar y segmentar contactos desde tu sistema: filtrá por nombre, teléfono, email, etiquetas, campos personalizados, país, fecha de alta o lead score. Es la base para sincronizar o exportar tu CRM.

Crear un contacto

POST /api/v1/contacts · Sirve para dar de alta un contacto nuevo (teléfono o WhatsApp ID, nombre, email) cuando sabés que no existe. Si no estás seguro, usá la operación de crear o actualizar.

Crear o actualizar un contacto

POST /api/v1/contacts/update-or-create · Usalo para sincronizar contactos desde tu sistema sin duplicarlos: si el teléfono ya existe lo actualiza, si no lo crea. Es la opción segura para reintentos.

Asignar un campo personalizado a contactos

POST /api/v1/contacts/attach-custom-field · Usalo para guardar datos propios de tu negocio en los contactos (plan, ciudad, fecha de compra): asigna valores de campos personalizados a uno o varios contactos en una sola llamada.

Quitar un campo personalizado de contactos

POST /api/v1/contacts/detach-custom-field · Sirve para borrar el valor de un campo personalizado en uno o varios contactos, por ejemplo cuando un dato quedó desactualizado en tu sistema.

Ver un contacto

GET /api/v1/contacts/{contact} · Usalo para traer la ficha completa de un contacto: datos, campos personalizados, estado de la conversación, mensajes sin leer y último mensaje.

Actualizar un contacto

PUT /api/v1/contacts/{contact} · Sirve para mantener al día la ficha de un contacto desde tu sistema: nombre, email, teléfono, notas, asesor asignado, favorito o si puede ejecutar flujos.

Listar las etiquetas de un contacto

GET /api/v1/contacts/{contact}/tags · Usalo para saber qué etiquetas tiene un contacto, por ejemplo para reflejar su segmento en tu CRM o decidir qué acción tomar.

Listar los campos personalizados de un contacto

GET /api/v1/contacts/{contact}/custom-fields · Sirve para leer los valores de los campos personalizados de un contacto, con búsqueda por nombre de campo.

Ver la ventana de 24 horas de un contacto

GET /api/v1/contacts/{contact}/meta-window · Usalo antes de escribirle a un contacto para saber si su ventana de 24 horas de Meta está abierta en un número, y así decidir si podés mandar un mensaje libre o necesitás una plantilla.

Listar los contactos de un número

GET /api/v1/devices/{device}/contacts · Sirve para listar los contactos asociados a uno de tus números conectados, útil si manejás varios números y querés separar la base por cada uno.

Eliminar contactos

POST /api/v1/contacts/delete · Usalo para borrar contactos en bloque: por IDs, por filtros (etiquetas, campos personalizados, país, fecha de alta) o todos. Ideal para limpiezas masivas de la base.

En esta página