ContactRead
A contact is a single address through which a lead is reached on a messaging channel. A lead can have several contacts (e.g. a phone number and a Telegram username). The (contact_type, channel_type, ext_channel_id, channel_vendor) combination defines exactly where the address is valid.
Unique numeric identifier of the record.
ID of the lead this record relates to.
ID of the product (workspace) that owns this record. Most endpoints scope access by product.
customer_id object
Canonical company-level customer ID shared by contacts and dialogues resolved as the same real customer; null for records not yet resolved.
- integer
- null
The address value itself — e.g. a phone number, a username, a chat id, or an email.
The kind of address — phone, username, chat_id, or email.
Possible values: [phone, username, chat_id, email]
name object
What the channel calls the owner of this address. Set whenever a name is known at all, and the one to display. It belongs to the contact rather than the lead: a lead can hold several contacts, each with its own name.
- string
- null
first_name object
Given name, only when the source split it itself (Bitrix24, for instance, sends firstName and lastName separately). It is never derived by splitting name, which would be a guess — so null here means "the source gave one string", not "no name".
- string
- null
last_name object
Family name, on the same terms as first_name.
- string
- null
channel_type objectrequired
The messaging platform the address is valid on. Null means universal (typically a phone number).
- string
- null
Possible values: [telegram, whatsapp, waba, max, viber, instagram, fasttrack, usedesk, salebot, avito, vk, yandex_messenger, email, sms, pinbox, linkedin, amocrm_salesbot, bitrix24_openlines, sip, webrtc, bothelp]
ext_channel_id objectrequired
Optional binding to a specific external channel; narrows where the address is used.
- string
- null
channel_vendor objectrequired
Optional messaging-provider vendor the address is pinned to.
- string
- null
Possible values: [wazzup24, self_wz, self_tg_bot, chatpush, greenapi, wappi, chatapp, yandex_messenger, salebot, bothelp, radist, fasttrack, usedesk, amocrm_salesbot, bitrix24_openlines, twilio, mail.ru, gmail, pinbox, unipile, voice]
Creation time (UTC, ISO 8601).
Whether this is the lead's primary contact.
crm_id object
Identifier of the matching record in the connected external CRM, if any.
- string
- null
Where this contact originated (e.g. api, custom_field, default_field, derived_title).
Possible values: [custom_field, classification, default_field, derived_title, api, unknown]
source_name object
Free-form label describing the origin of the contact.
- string
- null
last_dialogue_id objectrequired
ID of the most recent dialogue conducted through this contact.
- integer
- null
When true, the contact is excluded from automatic outreach routing.
waba_window_open_until objectrequired
For WhatsApp Business API contacts, when the current 24-hour free-form messaging window closes (UTC).
- date-time
- null
Count of WABA messaging windows opened for this contact so far.
{
"id": 0,
"lead_id": 0,
"product_id": 0,
"customer_id": 0,
"contact": "string",
"contact_type": "phone",
"name": "string",
"first_name": "string",
"last_name": "string",
"channel_type": "telegram",
"ext_channel_id": "string",
"channel_vendor": "wazzup24",
"created_at": "2024-07-29T15:51:28.071Z",
"is_main": true,
"crm_id": "string",
"contact_source": "custom_field",
"source_name": "string",
"last_dialogue_id": 0,
"skip_routing": true,
"waba_window_open_until": "2024-07-29T15:51:28.071Z",
"waba_windows_opened": 0
}