CreateContactRequest

phonestringnullable

Telefone em formato internacional. Sem código de país, use defaultCountry.

Possible values: <= 40 characters

bsuidstringnullable

Possible values: <= 160 characters

defaultCountrystring

País (ISO 3166-1 alfa-2) para ler um telefone sem código de país.

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

firstNamestringnullable

Possible values: <= 80 characters

lastNamestringnullable

Possible values: <= 80 characters

emailstring<email>nullable

Possible values: <= 254 characters

localestringnullable

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

Example: pt-BR

timezonestringnullable

Possible values: <= 64 characters

Example: America/Sao_Paulo

attributes object

Patch nos campos personalizados. null ou "" apagam o valor; o formato é validado pelo tipo do campo.

property name*any

Patch nos campos personalizados. null ou "" apagam o valor; o formato é validado pelo tipo do campo.

tagIdsstring[]

Ids das tags. Na edição, é o conjunto completo.

Possible values: <= 50

optIn object

Só na criação: registra o consentimento de marketing já no cadastro.

evidencestringrequired

Como o consentimento foi obtido — "checkbox no checkout do pedido 1042", por exemplo.

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

CreateContactRequest

{
  "phone": "string",
  "bsuid": "string",
  "defaultCountry": "string",
  "firstName": "string",
  "lastName": "string",
  "email": "[email protected]",
  "locale": "pt-BR",
  "timezone": "America/Sao_Paulo",
  "attributes": {},
  "tagIds": [
    "string"
  ],
  "optIn": {
    "evidence": "string"
  }
}