Contactos
Actualizar un contacto
Actualiza parcialmente un contacto (envía solo los campos que cambian).
contacts:writecontacts:write- 120/min
- Anotación del servidor: Destructiva
- Anotación del servidor: Idempotente
- Requiere confirmación humana
Resultado
generado desde el esquema
Requiere confirmación humana
Pon esta herramienta en la lista de «preguntar antes de ejecutar» de tu cliente. Las anotaciones son pistas que declara el servidor, no garantías: no decidas la aprobación solo por destructiveHint.
Las listas de emails, teléfonos y direcciones sustituyen por completo la lista existente. Devuelve el contacto actualizado en detalle.
Argumentos
Identificador del contacto.
Límites: longitud mín. 1
Nombre del contacto (persona o empresa).
Límites: longitud mín. 1, longitud máx. 200
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 lo borra ("" también se normaliza a null).
Límites: longitud máx. 20
Nombre comercial; null lo borra.
Límites: longitud máx. 200
Cargo o puesto; null lo borra.
Límites: longitud máx. 200
Lista de direcciones de correo electrónico que REEMPLAZA por completo la lista existente (máx. 20). Los ids internos los genera el servidor.
Límites: máx. 20 elementos
Mostrar atributos hijosOcultar atributos hijos
Dirección de email; se valida el formato.
Límites: longitud máx. 200
Etiqueta descriptiva del email (p. ej. "Personal", "Facturación").
Límites: longitud máx. 100
Marca este correo electrónico como el principal del contacto.
Lista de teléfonos que REEMPLAZA por completo la lista existente (máx. 20). Los ids internos los genera el servidor.
Límites: máx. 20 elementos
Mostrar atributos hijosOcultar atributos hijos
Número de teléfono.
Límites: longitud mín. 1, longitud máx. 50
Etiqueta descriptiva del teléfono (p. ej. "Móvil", "Oficina").
Límites: longitud máx. 100
Prefijo telefónico internacional del país (p. ej. "+34").
Límites: longitud máx. 10
Marca este teléfono como el principal del contacto.
Lista de sitios web que REEMPLAZA por completo la lista existente (máx. 20). Los ids internos los genera el servidor.
Límites: máx. 20 elementos
Mostrar atributos hijosOcultar atributos hijos
URL del sitio web; se valida el formato.
Límites: longitud máx. 300
Etiqueta descriptiva del sitio web (p. ej. "Web corporativa", "LinkedIn").
Límites: longitud máx. 100
Lista de direcciones que REEMPLAZA por completo la lista existente (máx. 20). Envía el id de cada dirección existente que quieras conservar; las direcciones sin id se crean con uno nuevo. Un id que no es una dirección de este contacto responde 400. Omitir una dirección que un pedido usa como dirección de facturación o de envío responde 409 address_in_use y no se cambia nada.
Límites: máx. 20 elementos
Mostrar atributos hijosOcultar atributos hijos
Identificador de una dirección existente para conservarla; omítelo para añadir una nueva.
Límites: longitud mín. 1
Etiqueta descriptiva de la dirección (p. ej. "Facturación", "Envío").
Límites: longitud máx. 100
Primera línea de la dirección (calle y número). Obligatorio.
Límites: longitud mín. 1, longitud máx. 300
Segunda línea de la dirección (piso, puerta, etc.).
Límites: longitud máx. 300
Ciudad de la dirección.
Límites: longitud máx. 200
Provincia o región de la dirección.
Límites: longitud máx. 200
Código postal de la dirección.
Límites: longitud máx. 20
País de la dirección (código o nombre corto).
Límites: longitud máx. 10
Marca esta dirección como la principal del contacto.
Carpeta o agrupación organizativa; null la borra.
Límites: longitud máx. 200
Número de contacto (referencia interna); null lo borra.
Límites: longitud máx. 50
Porcentaje de descuento general del contacto (0-100); null lo borra.
Límites: mín. 0, máx. 100
Si el contacto está suscrito a comunicaciones de marketing.
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 PATCH /api/v1/contacts/{contactId}.
Páginas relacionadas
Enlace a esta sección: Páginas relacionadasContactos
Actualizar un contacto
Actualiza parcialmente un contacto (envía solo los campos que cambian).
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?