Actualizar contacto en Omnisend, con una API

Actualiza un contacto. Solo cambian los campos enviados, pero tags reemplaza la lista completa de tags: para solo agregar tags, usa Aplicar tags. Un estado de canal en identifiers suscribe o da de baja al contacto.

Identificador
omnisend_update_contact

La llamada

POST https://connect.reportei.com/api/tools/omnisend_update_contact/execute
Authorization: Bearer <merchant token>
x-customer-token: <customer token>
Content-Type: application/json
Accept: application/json

{
  "customer_toolkit": "<connection UUID>",
  "arguments": {
    "id": "<id>"
  }
}

Tu sistema envía el id de la conexión de tu cliente y los argumentos de la tool. Los headers son los mismos de toda la API de Connect: el token de tu producto y el token de tu cliente.

Parámetros

Las descripciones de los parámetros siguen la documentación oficial de la app, en inglés.

ParámetroTipoObligatorioDescripción
idstringSíID of the contact, from List contacts.
identifiersarrayNoEmail and phone of the contact, each with the subscription status of its channel: email for the email identifier and sms for the phone identifier.
firstNamestringNoFirst name of the contact.
lastNamestringNoLast name of the contact.
tagsarrayNoThe full list of tags the contact keeps. An empty list removes every tag.
customPropertiesobjectNoCustom properties to change, keyed by name, with Latin letters, digits and underscores only. An empty value removes the property.
genderstringNoGender of the contact.Valores: m, f
birthdatestringNoBirth date of the contact, as YYYY-MM-DD.
addressstringNoStreet, number and apartment.
citystringNoCity.
statestringNoState as the ISO 3166-2 subdivision code, for example SP.
postalCodestringNoPostal code.
countryCodestringNoCountry as the ISO 3166-1 alpha-2 code, for example BR.

Conexiones posibles

Tu cliente conecta su cuenta de Omnisend una sola vez, con uno de los modos de abajo. La misma conexión sirve para todas las tools del toolkit.

Clave de API

Tu cliente pega la clave de la app en una pantalla de Connect, o tu sistema envía la clave con POST /api/customer-toolkits, sin pantalla.

La respuesta

Si la llamada tiene éxito, Connect conserva el status y el cuerpo de la respuesta de la app. Los errores HTTP devueltos por la app usan el objeto {error, api_error}; la autenticación o validación pueden fallar antes de la ejecución. El header X-Toolkit-Execution-Id identifica la ejecución registrada, disponible en GET /api/tools/executions/{uuid}.

Lista para agentes de IA

El input de esta tool es un JSON Schema, disponible en GET /api/tools/omnisend_update_contact. Se convierte en la definición de tool de tu agente sin conversión.

Otras tools de Omnisend

Ver las 14 tools

Toolkits de la misma categoría

Ver los 100 toolkits

Mira Connect aplicado a tu producto.

Pruébalo durante 15 días sin tarjeta, o cuéntale tu caso a nuestro equipo.