API de WhatsApp y CRM
PATCH/chat/{deviceId}/contacts

Crear contactos en lote

Crea contactos en lote, hasta 1000 contactos a la vez en una sola solicitud a la API.

API de WhatsApp y CRM
Necesitas una clave de API. Pídela a nuestro equipo de soporte o créala desde la plataforma.
PATCH https://api.getincloud.ai/v1/chat/{deviceId}/contacts

Crea contactos en lote, hasta 1000 contactos a la vez en una sola solicitud a la API.

Este endpoint de la API es útil para crear varios contactos a la vez y es más eficiente que llamar varias veces al endpoint Create contact.

Al igual que en el endpoint Create contact, cada contacto proporcionado debe tener un número de teléfono en formato E164 (p. ej.: +1234567890) en la agenda interna de contactos de la plataforma del número de WhatsApp conectado.

Los contactos creados desde la API de la plataforma o desde el chat no se sincronizan con la agenda del móvil de WhatsApp conectado, por lo que es posible que los contactos aparezcan en la aplicación móvil de WhatsApp con el número de teléfono sin formato en lugar del nombre del contacto.

Por defecto se usa el parámetro de consulta upsert=true, lo que significa que si el número de teléfono ya está en uso por un contacto existente en el almacén de contactos del dispositivo específico, el contacto existente se actualizará con la información proporcionada. Puedes cambiar este comportamiento usando el parámetro de consulta upsert=false.

Según la cantidad de contactos que necesites crear, la respuesta puede tardar varios segundos.

Prueba aquí el ejemplo de uso de la API para importar varios contactos

Tutoriales relacionados:

Nota: por defecto, a menos que se defina el parámetro de consulta ?upsert=true, si el número de teléfono ya está en uso por un contacto existente en el almacén de contactos del dispositivo específico, la API devolverá en el JSON de respuesta un campo de error con 409 - Conflict y se devolverá el ID de WhatsApp del contacto existente en la respuesta de error, que luego se puede usar para actualizar el contacto existente mediante el [endpoint Update contact](#operation/updateContact).


Prueba este endpoint en el probador de API en vivo

>¿Necesitas ayuda? Explora todos los tutoriales, más de 100 ejemplos de casos de uso y juega con el probador de API en vivo con ejemplos de código listos para usar en más de 15 lenguajes de programación, incluidos JavaScript/Node.js, PHP, Python, C#, Java, Ruby, Swift, Kotlin, Powershell, cURL y más.

Autenticación

Envía tu API key en el encabezado Token en cada petición.

Parámetros

CampoDóndeTipoObligatorioDescripción
upsertquerybooleanNoSi es true y el contacto ya existe, el contacto se actualizará con los datos proporcionados. Si es false y el contacto ya existe, se omitirá la creación del contacto y la entrada del contacto se devolverá como código de error 409 en el arreglo de resultados. default: True

Respuestas

CódigoDescripción
200Contactos creados
202Contactos creados parcialmente y algunos fallaron
400Cuerpo de la solicitud no válido
401No autorizado - Token de API no válido o ausente
403No autorizado o faltan permisos
404Recurso no encontrado
409Conflicto
429Se alcanzó el límite máximo de contactos - Se requiere mejorar el plan
500Error inesperado
501No implementado
503Servicio temporalmente no disponible - Inténtalo de nuevo más tarde
// This code example requires you to have installed curl package
// Installation instructions here: https://curl.haxx.se/download.html

// Create multiple contacts
curl --request PATCH \
  --url https://api.getincloud.ai/v1/chat/{deviceId}/contacts \
  --header 'Content-Type: application/json' \
  --header 'Token: <api token goes here>' \
  --data '[{"name":"John","surname":"Doe","kind":"personal","email":"john@domain.com","phone":"+1234567890","country":"US","city":"Ney York","postalCode":"12345","metadata":[{"key":"CRM_ID","value":"12345678"}]},{"name":"Michael","surname":"Jackson","kind":"personal","email":"mike@jackson5.com","phone":"+1234561234","country":"US","city":"Los Angeles","postalCode":"52345","metadata":[{"key":"CRM_ID","value":"5555555"}]}]'
AnteriorCrear contactoSiguienteCrear nota
¿Te sirvió esta página?