Contactos
Relacionar dos contactos
Vincula un contacto con otro mediante un rol (la persona de contacto de una empresa, el director de una producción).
contacts:writeResultado
generado desde el esquema
Una empresa que relaciona a una persona debe indicar el rol (400 en caso contrario); una persona que relaciona a una empresa no debe indicarlo (el rol vive en la relación inversa); cualquier otro par es libre y el rol se registra. 409 si el par ya estaba relacionado. Devuelve la relación tal como queda registrada. Devuelve el contacto completo, con relatedContacts tal como quedan ahora, la misma proyección que su GET.
Argumentos
Identificador del contacto principal.
Límites: longitud mín. 1
Rol de la relación, p. ej. "Director", "Persona de contacto". Obligatorio cuando una empresa relaciona a una persona; no permitido cuando una persona relaciona una empresa.
Límites: longitud máx. 200
Clave de idempotencia elegida por el cliente (se recomienda un UUID). Repetir la misma clave con los mismos argumentos en 24 h devuelve la respuesta almacenada sin volver a ejecutar; con argumentos distintos responde 422. Es la forma segura de reintentar tras un fallo de red.
Límites: longitud mín. 1, longitud máx. 255
Bloqueo optimista: el meta.etag que obtuviste de la lectura de detalle de este recurso (o "*"). Si el recurso ha cambiado desde entonces, la llamada falla con 412 precondition_failed antes de escribir nada; léelo de nuevo y reintenta. Omítelo para escribir sin condiciones.
Límites: longitud mín. 1
Resultado
En un éxito el resultado lleva structuredContent con data y meta. Estos son los atributos de data.
Ver los atributos de data
Identificador único del contacto.
Nombre del contacto (persona o empresa).
Tipo de contacto: person (particular) o company (negocio).
Opciones disponibles: person, company
Rol del contacto: client, provider, lead, debtor, creditor, student, teacher o unspecified.
Opciones disponibles: client, provider, lead, debtor, creditor, student, teacher, unspecified
Estado del contacto: active (operativo), inactive (desactivado) o archived (cerrado, conservado como histórico).
Opciones disponibles: active, inactive, archived
NIF/CIF o número de identificación fiscal; null si no se ha registrado.
Nombre comercial; null si coincide con el nombre o no consta.
Cargo o puesto de la persona de contacto; null si no está registrado.
Número de contacto asignado por la cuenta (referencia interna); null si no consta.
Lista de direcciones de correo electrónico del contacto.
Mostrar atributos hijosOcultar atributos hijos
Identificador interno del correo electrónico dentro del contacto.
Etiqueta descriptiva del email; null si no tiene.
Dirección de email.
Si este es el email principal del contacto.
Email de facturación dedicado; null significa que se usa el email principal.
Lista de teléfonos del contacto.
Mostrar atributos hijosOcultar atributos hijos
Identificador interno del teléfono dentro del contacto.
Etiqueta descriptiva del teléfono; null si no tiene.
Número de teléfono.
Prefijo telefónico internacional del país (p. ej. "+34"); null si no consta.
Si este es el teléfono principal del contacto.
Lista de sitios web del contacto.
Mostrar atributos hijosOcultar atributos hijos
Identificador interno del sitio web dentro del contacto.
Etiqueta descriptiva del sitio web; null si no tiene.
URL del sitio web.
Lista de direcciones del contacto.
Mostrar atributos hijosOcultar atributos hijos
Identificador interno de la dirección dentro del contacto.
Etiqueta descriptiva de la dirección; null si no tiene.
Primera línea de la dirección; null si no consta.
Segunda línea de la dirección; null si no consta.
Ciudad; null si no consta.
Provincia o región; null si no se ha registrado.
Código postal; null si no se ha registrado.
País; null si no consta.
Si esta es la dirección principal del contacto.
Carpeta o agrupación organizativa; null si el contacto no está clasificado.
Porcentaje de descuento general del contacto (0-100); null si no hay descuento configurado.
Idioma preferido del contacto; null si no se ha registrado.
Moneda por defecto del contacto como código ISO 4217; null si no consta.
Método de pago preferido del contacto; null si no está configurado.
Mostrar atributos hijosOcultar atributos hijos
Tipo de método de pago: bank_transfer, card, cash, sepa_direct_debit u other.
Opciones disponibles: bank_transfer, card, cash, other, sepa_direct_debit
Detalle en texto libre cuando el tipo es "other" (por ejemplo, un método registrado antes de configurarse); null en caso contrario.
Días del mes en que el contacto hace pagos; null si no está configurado.
Días de vencimiento por defecto de las facturas del contacto; null si no está configurado.
Si el contacto está suscrito a comunicaciones de marketing.
Si el contacto tiene acceso a la app.
Valores de los campos personalizados por identificador de campo personalizado; las definiciones están en /api.
Fecha de creación en ISO 8601 con desplazamiento.
Fecha de la última actualización en ISO 8601 con desplazamiento.
Un error es un resultado con isError: true y el problema en content[0].; no hay structuredContent. Consulta Errores.
La misma operación por REST
Esta herramienta ejecuta POST /api/v1/contacts/{contactId}/related-contacts.
Páginas relacionadas
Enlace a esta sección: Páginas relacionadasContactos
Relacionar dos contactos
Vincula un contacto con otro mediante un rol (la persona de contacto de una empresa, el director de una producción).
Guías
Escrituras seguras
Un asistente que puede escribir también puede escribir lo equivocado. Decide qué herramientas necesitan a una persona, reintenta sin duplicar y sabe qué pone en marcha una escritura.
Guías
Errores
Un error de herramienta es un resultado con
isError: truey el problema en el primer bloque de texto. Ramifica por sucode.
¿Te ha resultado útil esta página?