Actualizar un contacto

Actualiza parcialmente el nombre, etiquetas, campos personalizados o usuario asignado de un contacto.

PATCH/contacts/:uuid

Autenticación

Este endpoint se autentica con tu API key enviada en la cabecera X-API-Key (formato ek_live_...). Puedes gestionar tus API keys desde la sección Dev Tools del panel.

Parámetros de ruta

ParámetroTipoObligatorioDescripción
uuidStringObligatorioUUID del contacto a actualizar.

Cuerpo de la solicitud

ParámetroTipoObligatorioDescripción
nameStringOpcionalNombre completo; se divide en nombre y apellido.
tagsArrayOpcionalLista completa de etiquetas del contacto; reemplaza las existentes y se sincroniza con sus conversaciones.
custom_fieldsObjectOpcionalPares clave-valor que se combinan con los campos personalizados existentes del contacto.
assigned_userStringOpcionalEmail del usuario del negocio al que asignar el contacto.
unassign_userBooleanOpcionalSi es true, elimina el usuario asignado actual.

Ejemplo de solicitud

bash
curl -X PATCH "https://eclectic-api-537143970188.us-central1.run.app/api/external/v2/contacts/eb2b914a-977e-4ab8-96e7-b886698b3eac" \
  -H "X-API-Key: ek_live_your_api_key_here" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "John Doe",
    "tags": ["vip"],
    "custom_fields": {
      "rut": "12345678-9"
    },
    "assigned_user": "agent@example.com"
  }'

Ejemplo de respuesta

json
{
  "contact": [
    {
      "uuid": "eb2b914a-977e-4ab8-96e7-b886698b3eac",
      "name": "John Doe",
      "phoneNumber": "+56912345678",
      "avatarUrl": null,
      "createdAt": "2024-09-23T20:09:10Z",
      "source": "whatsapp",
      "closedAt": null,
      "href": "https://dash.try-eclectic.com/contacts/eb2b914a977e4ab896e7b886698b3eac",
      "conversationHref": "https://dash.try-eclectic.com/chat/f3670b13446b412796238b1cd78899f9",
      "tags": ["vip"],
      "assignedUser": "agent@example.com",
      "customFields": {
        "rut": "12345678-9"
      }
    }
  ]
}

Notas

  • custom_fields se combinan con los valores existentes; solo se actualizan las claves que envíes.
  • tags es un reemplazo completo, no una combinación — envía la lista completa.
  • Errores posibles: 400 (validación), 401 (API key inválida o ausente), 404 (contacto no encontrado).