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

Actualizar contacto

Actualiza la información de un contacto por su ID de contacto de WhatsApp.

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/{contactWid}

Actualiza la información de un contacto por su ID de contacto de WhatsApp.

Ejemplo de ID de WhatsApp: 123456789@c.us, donde 123456789 representa el número de teléfono internacional.

Nota: para eliminar o desactivar uno o varios campos, usa el campo $remove con un array de nombres de campo (string) que contenga los que quieras eliminar o desactivar.

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.

Cuerpo de la petición

CampoTipoObligatorioDescripción
$removearray<string>NoElimina uno o varios campos de datos estableciendo el valor como null. Útil para borrar información del contacto cuando no se acepta una cadena vacía.
namestringNomaxLength: 30
surnamestringNomaxLength: 50
titlestringNomaxLength: 15
kindstringNoenum: ['personal', 'business']
genderstringNoenum: ['male', 'female', 'other']
altPhonestringNoNúmero de teléfono secundario en formato compatible con E164. Ej: +1234567890 minLength: 6 · maxLength: 20
emailstringNominLength: 5 · maxLength: 100 · format: email
descriptionstringNomaxLength: 100
languagesarray<string>No
companyNamestringNomaxLength: 50
companyCodestringNomaxLength: 50
companyTaxIdstringNomaxLength: 30
companyRolestringNomaxLength: 30
companyWebsitestringNominLength: 6 · maxLength: 100
companyEmailstringNominLength: 5 · maxLength: 100 · format: email
companyPhonestringNoNúmero de teléfono de la empresa en formato compatible con E164. Ej: +1234567890 minLength: 2 · maxLength: 18
companyCountrystringNoCódigo alpha-2 ISO 3166 del país de la empresa. Más información minLength: 2 · maxLength: 2
currencystringNoCódigo ISO alpha-3 de la moneda. Más información minLength: 3 · maxLength: 3
addressstringNomaxLength: 100
citystringNomaxLength: 30
postalCodestringNomaxLength: 20
countrystringNoCódigo alpha-2 ISO 3166 del país. Más información minLength: 2 · maxLength: 2
notesstringNoNotas internas en texto plano sobre este contacto. Al establecer este campo se sobrescribirá el texto de notas existente. minLength: 0 · maxLength: 3000
birthdaystringNoformat: date-time
notificationsstringNoenum: ['on', 'mute', 'ignore']
timezonestringNoZona horaria de la ubicación del contacto. Lista de valores admitidos minLength: 2 · maxLength: 40
crmstringNoNombre opcional del CRM externo de origen. Ej: hubspot, dynamics, zoho, bitrix, salesforce... minLength: 2 · maxLength: 50
crmRefstringNoReferencia opcional del usuario en un CRM externo, como un ID, un correo electrónico o una URL al contacto en un sistema CRM externo. minLength: 2 · maxLength: 500
syncbooleanNoActiva la sincronización automática del contacto en todos los números de WhatsApp conectados en tu cuenta. Esta opción está desactivada por defecto. Para sincronizar un contacto solo en números de WhatsApp específicos, usa el campo syncNumbers. default: False
syncNumbersarray<string>NoActiva la sincronización automática del contacto en varios números de WhatsApp conectados en tu cuenta. Usa all para sincronizar el contacto en todos los números conectados de tu cuenta, o usa el ID del número de destino (hexadecimal de 24 caracteres) para seleccionar los números con los que quieres sincronizar el contacto. Esta opción está desactivada por defecto.
metadataarray<object>No
linksarray<object>No
subscriptionobjectNoActualiza la configuración de suscripción a campañas de este contacto
subscription.statusstringNoEstablece el estado de suscripción de este contacto enum: ['subscribed', 'active', 'exclude', 'unsubscribed']

Respuestas

CódigoDescripción
200Contacto actualizado
400Solicitud no válida
401No autorizado: token de API no válido o ausente
403Permisos insuficientes
404Contacto no encontrado
409Conflicto
429Demasiadas solicitudes: inténtalo de nuevo más tarde
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

// Update contact information
curl --request PATCH \
  --url https://api.getincloud.ai/v1/chat/{deviceId}/contacts/{contactWid} \
  --header 'Content-Type: application/json' \
  --header 'Token: <api token goes here>' \
  --data '{"name":"John","surname":"Doe","email":"john@domain.com","country":"US","city":"Ney York","postalCode":"1234","kind":"personal","metadata":[{"key":"CRM_ID","value":"12345678"}]}'


// Update and remove multiple fields
curl --request PATCH \
  --url https://api.getincloud.ai/v1/chat/{deviceId}/contacts/{contactWid} \
  --header 'Content-Type: application/json' \
  --header 'Token: <api token goes here>' \
  --data '{"$remove":["city","postalCode","surname"],"email":"john@new-domain.com","country":"GB"}'
AnteriorActualizar atributos del chatSiguienteActualizar el estado del chat
¿Te sirvió esta página?