ContactSyncRequest

contacts object[]required

Um texto vazio conta como ausente.

Possible values: >= 1, <= 500

Array [

ref objectrequired

Quem a pessoa é no site — o vínculo que acha o mesmo contato mesmo depois de uma troca de número.

kindstringrequired

wp_user: usuário do WordPress. wc_customer: cliente do WooCommerce. wc_guest: compra sem conta. lead: alguém conhecido só por um formulário ou um carrinho.

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

idstringrequired

O id da pessoa no site. Quem não tem conta (wc_guest, lead) vai pelo sha256 do e-mail.

Possible values: non-empty and <= 191 characters

Example: 42

phonestringnullable

Em qualquer formato; é normalizado para E.164. Sem o código do país, vale country ou options.defaultCountry.

Possible values: <= 40 characters

countrystringnullable

País do endereço de cobrança (ISO 3166 alfa-2) — é como um número digitado sem o código do país é lido.

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, pela chave. Só preenchem o que está vazio — menos os campos que o próprio site calcula, que sobrescrevem.

property name*any

Campos personalizados, pela chave. Só preenchem o que está vazio — menos os campos que o próprio site calcula, que sobrescrevem.

tagsstring[]

Nomes de tags a adicionar. As que não existem são criadas.

Possible values: <= 20

removeTagsstring[]

Nomes de tags a tirar do contato.

Possible values: <= 20

consent object

O consentimento que a pessoa deu ou retirou no site. Um opt-out sempre vale; um opt-in só passa um contato de unknown para opted_in, nunca por cima de um opt-out ou de uma supressão.

oneOf

• Opt-in
• Opt-out

statusstringrequired

Possible values: [opted_in]

evidencestringrequired

O que a pessoa aceitou e onde: o texto da caixa marcada, o pedido, o site.

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

atstring<date-time>

Quando a pessoa aceitou.

occurredAtstring<date-time>required

Quando o site leu esses valores — é o que ordena duas fotos da mesma pessoa.

]

options object

triggersboolean

true inicia fluxos e envia webhooks pelo que mudou. false, para uma carga inicial, não dispara nada.

Default value: false

defaultCountrystring

País usado nos telefones sem código de país, quando a linha não traz 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"
  }
}