Saltar al contenido principal
PUT
Actualizar contacto

Autorizaciones

Authorization
string
header
requerido

Token JWT de autenticación

Encabezados

x-company-id
string

Identificador de la empresa objetivo. Obligatorio solo para API keys globales (type=global). Se ignora para API keys de empresa y usuarios humanos.

Parámetros de ruta

id
string
requerido

ID del contacto

Cuerpo

application/json
name
string

Nombre completo del contacto. Opcional en la actualización.

country_code
string

Código de país para llamadas (1-3 dígitos). Ejemplos: 55 (Brasil), 1 (EE. UU.), 351 (Portugal).

email
string

Dirección de correo electrónico del contacto. Un correo que ya pertenece a otro contacto de la empresa devuelve 409.

linkedin_identifier
string

Identificador del perfil de LinkedIn del contacto (URL o nombre del perfil). Un LinkedIn que ya pertenece a otro contacto de la empresa devuelve 409.

phone_number
string

Número de teléfono sin formato, solo dígitos (código de área + número, sin el código de país). Ejemplo: 11999998888. El número se normaliza; si es inválido, devuelve 400. Un teléfono que ya pertenece a otro contacto de la empresa devuelve 409.

job_title
string

Cargo del contacto. Ejemplo: Gerente de Ventas.

seniority
string

Nivel de seniority del contacto. Ejemplo: Senior, Junior, Semi-senior.

department
string

Departamento del contacto. Ejemplo: Comercial, TI, Marketing.

country
string

País del contacto. Ejemplo: Brasil.

region
string

Estado o región del contacto. Ejemplo: São Paulo.

city
string

Ciudad del contacto. Ejemplo: São Paulo.

experience
string

Experiencia profesional del contacto.

skills
string

Habilidades del contacto.

additional_attributes
object

Campos personalizados del contacto. Formato: { "slug_del_campo": valor }. Los slugs deben corresponder a custom fields registrados con contexto CONTACT. Los slugs inválidos o inexistentes se ignoran en silencio. Los valores se combinan con los atributos existentes (merge); no se reemplaza todo el objeto. Los valores deben ser primitivos (string, number, boolean o null). Ejemplo: { "cpf": "12345678900", "valor_total": 2500.00 }

custom_fields
object

Actualiza los valores de los campos personalizados del contacto, por slug. Cubre select ({ "slug": "<option_id>" }), multi_select ({ "slug": ["", ""] }) y text ({ "slug": "valor" }). Para number/date, use additional_attributes, que conserva el tipo nativo. Validación atómica: si algún valor es inválido, no se guarda ningún custom field. Un slug sin custom field correspondiente devuelve 404; una opción inválida devuelve 422; un valor no textual en un campo text devuelve 400. No lo envíe junto con additional_attributes en el mismo payload: el guardado de additional_attributes sobrescribe el de custom_fields. Los option_id se obtienen de GET /v1/custom-fields/{id}/options.

business
string | null

ID del Business al que pertenece el contacto (null para quitarlo).

Respuesta

Contacto actualizado correctamente

name
string
requerido

Nombre del contacto

company
any
requerido

Empresa del contacto

_id
string

ID del contacto

id
string

ID del contacto (mismo valor que _id)

country_code
string

Código de país del número. Ausente junto con el teléfono cuando el contacto solo tiene un identificador de WhatsApp.

email
string

Email del contacto

last_activity_at
any

Fecha de la última actividad del contacto

phone_number
string

Número de teléfono del contacto. Ausente cuando el contacto solo tiene un identificador de WhatsApp.

linkedin_identifier
string

Identificador del perfil de LinkedIn

job_title
string

Cargo del contacto

seniority
string

Nivel de seniority del contacto

department
string

Departamento del contacto

country
string

País del contacto

region
string

Estado o región del contacto

city
string

Ciudad del contacto

experience
string

Experiencia profesional del contacto

skills
string

Habilidades del contacto

additional_attributes
object

Valores de los campos personalizados del contacto, por slug. Si se guardó vía additional_attributes, el valor viene en el envoltorio { id, value, type, updatedAt }. Si se guardó vía custom_fields (PUT), viene sin envoltorio: el option_id (select), la lista de option_id (multi_select) o el texto (text).

business
string | null

ID del Business al que pertenece el contacto

notes
object[]

Notas registradas en el contacto

marketing_opt_out
object

Opt-out de marketing por medio de comunicación (whatsapp, email, linkedin). Ausente o vacío cuando el contacto no pidió salir de ningún medio.

whatsapp_user_id
string

Identificador del contacto en WhatsApp (BSUID), asignado por Meta. String opaco.

whatsapp_username
string

@username del contacto en WhatsApp, tal como lo envía Meta

whatsapp_parent_user_id
string

parent_user_id del contacto en WhatsApp, tal como lo envía Meta

createdAt
any

Fecha de creación del contacto

updatedAt
any

Fecha de actualización del contacto