CreateContactRequest

phonestringnullable

Phone in international format. Without a country code, use defaultCountry.

Possible values: <= 40 characters

bsuidstringnullable

Possible values: <= 160 characters

defaultCountrystring

Country (ISO 3166-1 alpha-2) to read a phone without a country code.

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 over the custom fields. null or "" clear the value; the format is validated by the field type.

property name*any

Patch over the custom fields. null or "" clear the value; the format is validated by the field type.

tagIdsstring[]

Tag ids. On an edit, it is the complete set.

Possible values: <= 50

optIn object

Creation only: records marketing consent at sign-up.

evidencestringrequired

How consent was obtained — "checkbox at checkout of order 1042", for instance.

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"
  }
}