ContactSyncRequest

contacts object[]required

Un texto vacío cuenta como ausente.

Possible values: >= 1, <= 500

Array [

ref objectrequired

Quién es la persona en el sitio — el vínculo que encuentra al mismo contacto incluso después de un cambio de número.

kindstringrequired

wp_user: usuario de WordPress. wc_customer: cliente de WooCommerce. wc_guest: compra sin cuenta. lead: alguien conocido solo por un formulario o un carrito.

Possible values: [wp_user, wc_customer, wc_guest, lead]

idstringrequired

El id de la persona en el sitio. Quien no tiene cuenta (wc_guest, lead) va por el sha256 de su e-mail.

Possible values: non-empty and <= 191 characters

Example: 42

phonestringnullable

En cualquier formato; se normaliza a E.164. Sin el código de país, vale country u options.defaultCountry.

Possible values: <= 40 characters

countrystringnullable

País de la dirección de facturación (ISO 3166 alfa-2) — es como se lee un número escrito sin el código de país.

Possible values: >= 2 characters and <= 2 characters

firstNamestringnullable

Possible values: <= 80 characters

lastNamestringnullable

Possible values: <= 80 characters

emailstringnullable

Possible values: <= 254 characters

localestringnullable

Possible values: Value must match regular expression ^[a-z]{2}(-[A-Z]{2})?$

Example: pt-BR

attributes object

Campos personalizados, por clave. Solo rellenan lo que está vacío — salvo los campos que calcula el propio sitio, que sobrescriben.

property name*any

Campos personalizados, por clave. Solo rellenan lo que está vacío — salvo los campos que calcula el propio sitio, que sobrescriben.

tagsstring[]

Nombres de etiquetas a añadir. Las que no existen se crean.

Possible values: <= 20

removeTagsstring[]

Nombres de etiquetas a quitar del contacto.

Possible values: <= 20

consent object

El consentimiento que la persona dio o retiró en el sitio. Una baja siempre vale; un opt-in solo pasa un contacto de unknown a opted_in, nunca por encima de una baja o de una supresión.

oneOf

• Opt-in
• Opt-out

statusstringrequired

Possible values: [opted_in]

evidencestringrequired

Qué aceptó la persona y dónde: el texto de la casilla marcada, el pedido, el sitio.

Possible values: >= 3 characters and <= 500 characters

atstring<date-time>

Cuándo aceptó la persona.

occurredAtstring<date-time>required

Cuándo leyó el sitio estos valores — es lo que ordena dos fotos de la misma persona.

]

options object

triggersboolean

true inicia flujos y envía webhooks por lo que cambió. false, para una carga inicial, no dispara nada.

Default value: false

defaultCountrystring

País usado en los teléfonos sin código de país, cuando la fila no trae country.

Possible values: >= 2 characters and <= 2 characters

ContactSyncRequest

{
  "contacts": [
    {
      "ref": {
        "kind": "wp_user",
        "id": "42"
      },
      "phone": "string",
      "country": "string",
      "firstName": "string",
      "lastName": "string",
      "email": "string",
      "locale": "pt-BR",
      "attributes": {},
      "tags": [
        "string"
      ],
      "removeTags": [
        "string"
      ],
      "consent": {
        "status": "opted_in",
        "evidence": "string",
        "at": "2024-07-29T15:51:28.071Z"
      },
      "occurredAt": "2024-07-29T15:51:28.071Z"
    }
  ],
  "options": {
    "triggers": false,
    "defaultCountry": "string"
  }
}