Contact

idstring

phonestringnullable

E.164 without the +.

Example: 5541987111527

countrystringnullable

Example: BR

waIdstringnullable

bsuidstringnullable

usernamestringnullable

profileNamestringnullable

firstNamestringnullable

lastNamestringnullable

namestringnullable

First and last name, or the WhatsApp profile name when there is no name.

emailstringnullable

localestringnullable

timezonestringnullable

attributes object

Custom field values, keyed by the field key.

property name*any

Custom field values, keyed by the field key.

sourcestring

Possible values: [manual, import, api, inbound, flow]

optInStatusstring

Possible values: [opted_in, opted_out, unknown]

optInAtstring<date-time>nullable

optInSourcestringnullable

Possible values: [import, api, form, keyword, flow, manual]

optInEvidencestringnullable

optOutAtstring<date-time>nullable

optOutSourcestringnullable

Possible values: [keyword, button, meta_131050, manual, api, flow]

optOutReasonstringnullable

tags object[]

Array [

idstring

namestring

colorstringnullable

]

lastInboundAtstring<date-time>nullable

lastOutboundAtstring<date-time>nullable

lastCampaignAtstring<date-time>nullable

createdAtstring<date-time>

updatedAtstring<date-time>

Contact

{
  "id": "string",
  "phone": "5541987111527",
  "country": "BR",
  "waId": "string",
  "bsuid": "string",
  "username": "string",
  "profileName": "string",
  "firstName": "string",
  "lastName": "string",
  "name": "string",
  "email": "string",
  "locale": "string",
  "timezone": "string",
  "attributes": {},
  "source": "manual",
  "optInStatus": "opted_in",
  "optInAt": "2024-07-29T15:51:28.071Z",
  "optInSource": "import",
  "optInEvidence": "string",
  "optOutAt": "2024-07-29T15:51:28.071Z",
  "optOutSource": "keyword",
  "optOutReason": "string",
  "tags": [
    {
      "id": "string",
      "name": "string",
      "color": "string"
    }
  ],
  "lastInboundAt": "2024-07-29T15:51:28.071Z",
  "lastOutboundAt": "2024-07-29T15:51:28.071Z",
  "lastCampaignAt": "2024-07-29T15:51:28.071Z",
  "createdAt": "2024-07-29T15:51:28.071Z",
  "updatedAt": "2024-07-29T15:51:28.071Z"
}