Sign in
latestOpenAPI 3.0.2MIT2026-08-1745267541.8 KB

bdb3e0c48bf7

Contact

Create a Contact

Most Conversation API contacts are created automatically when a message is sent to a new recipient. You can also create a new contact manually using this API call.

post/v1/projects/{project_id}/contacts

Request body

channel_priorityConversationChannel[]

List of channels defining the channel priority. The channel at the top of the list is tried first.

display_namestring

The display name. A default 'Unknown' will be assigned if left empty.

emailstring

Email of the contact.

external_idstring

Contact identifier in an external system.

language'AF' | 'SQ' | 'AR' | 'AZ' | 'BN' | 'BG' | 'CA' | 'ZH' | 'ZH_CN' | 'ZH_HK' | 'ZH_TW' | 'HR' | 'CS' | 'DA' | 'NL' | 'EN' | 'EN_GB' | 'EN_US' | 'ET' | 'FIL' | 'FI' | 'FR' | 'DE' | 'EL' | 'GU' | 'HA' | 'HE' | 'HI' | 'HU' | 'ID' | 'GA' | 'IT' | 'JA' | 'KN' | 'KK' | 'KO' | 'LO' | 'LV' | 'LT' | 'MK' | 'MS' | 'ML' | 'MR' | 'NB' | 'FA' | 'PL' | 'PT' | 'PT_BR' | 'PT_PT' | 'PA' | 'RO' | 'RU' | 'SR' | 'SK' | 'SL' | 'ES' | 'ES_AR' | 'ES_ES' | 'ES_MX' | 'SW' | 'SV' | 'TA' | 'TE' | 'TH' | 'TR' | 'UK' | 'UR' | 'UZ' | 'VI' | 'ZU' required
metadatastring

Metadata associated with the contact. Up to 1024 characters long.

Example request

{
  "channel_identities": [
    {
      "channel": "WHATSAPP"
    }
  ],
  "channel_priority": [
    "WHATSAPP"
  ]
}

Response

A successful response.

channel_priorityConversationChannel[]

List of channels defining the channel priority.

display_namestring

The display name. A default 'Unknown' will be assigned if left empty.

emailstring

Email of the contact.

external_idstring

Contact identifier in an external system.

idstring

The ID of the contact.

language'AF' | 'SQ' | 'AR' | 'AZ' | 'BN' | 'BG' | 'CA' | 'ZH' | 'ZH_CN' | 'ZH_HK' | 'ZH_TW' | 'HR' | 'CS' | 'DA' | 'NL' | 'EN' | 'EN_GB' | 'EN_US' | 'ET' | 'FIL' | 'FI' | 'FR' | 'DE' | 'EL' | 'GU' | 'HA' | 'HE' | 'HI' | 'HU' | 'ID' | 'GA' | 'IT' | 'JA' | 'KN' | 'KK' | 'KO' | 'LO' | 'LV' | 'LT' | 'MK' | 'MS' | 'ML' | 'MR' | 'NB' | 'FA' | 'PL' | 'PT' | 'PT_BR' | 'PT_PT' | 'PA' | 'RO' | 'RU' | 'SR' | 'SK' | 'SL' | 'ES' | 'ES_AR' | 'ES_ES' | 'ES_MX' | 'SW' | 'SV' | 'TA' | 'TE' | 'TH' | 'TR' | 'UK' | 'UR' | 'UZ' | 'VI' | 'ZU'
metadatastring

Metadata associated with the contact. Up to 1024 characters long.

Example response

{
  "channel_identities": [
    {
      "channel": "WHATSAPP"
    }
  ],
  "channel_priority": [
    "WHATSAPP"
  ],
  "id": "{CONTACT_ID}"
}