Saltar al contenido
Índice

Dar de alta un contacto

POST/v1/crm/contacts

En la empresa de la llave, sin responsable. Si ya hay una ficha con ese correo, 409 duplicate (con su id si la llave puede ver). El teléfono no cuenta como duplicado: busca antes.

Permiso de la llave:«Dar de alta contactos» (contacts_write)Permiso del rol:crm.edit

Cabeceras

  • Authorizationstringobligatorio

    Bearer y el secreto de la llave.

  • Idempotency-Keystring

    Recomendada. De 1 a 200 caracteres. La misma clave y la misma petición devuelven la misma respuesta durante 24 h, sin repetirla. Sin ella, un reintento se hace otra vez.

Cuerpo

JSON, con Content-Type: application/json.

  • firstNamestringobligatorio

    Nombre.

    hasta 100 caracteres

  • lastNamestring

    Apellidos.

    hasta 100 caracteres

  • jobTitlestring

    Cargo.

    hasta 150 caracteres

  • counterpartyIdstring

    La cuenta (empresa cliente) a la que pertenece, de las que alcanza la llave.

    uuid · hasta 36 caracteres

  • phonesarray de object

    Sus teléfonos. El primero es el principal.

    hasta 10 elementos

  • phones[].numberstringobligatorio

    En E.164 (se aceptan espacios).

    teléfono E.164 · hasta 40 caracteres

  • phones[].kindstring

    De qué es. Por omisión, work.

    uno de: work, personal, other

  • emailsarray de string

    Sus correos. El primero es el principal.

    hasta 10 elementos · correo · hasta 254 caracteres

Respuestas

  • 201Creado.Ver campos
    • idstringobligatorio

      Su id.

      uuid · hasta 36 caracteres

  • 400Algo no es válido: error.field dice qué.
  • 401Sin llave, o no vale.
  • 403Fuera del plan (code plan); la llave sin el permiso de su rol o sin el permiso de API de la operación (code forbidden); o desde una IP que la llave no permite (code ip_not_allowed).
  • 409duplicate, conflict, idempotency_conflict o in_progress.
  • 413El cuerpo es demasiado grande.
  • 429Más de 120 peticiones por minuto con la llave, o de 600 en la organización. Con Retry-After.
  • 503No se pudo atender. Con Retry-After: repítela.