Skip to main content
POST
Create a conversation

Yetkilendirmeler

Authorization
string
header
gerekli

The access token received from the authorization server in the OAuth 2.0 flow.

Başlıklar

X-Tenant
number
gerekli

Tenant identifier. Send the Tenant ID in the X-Tenant header to scope API requests to a specific tenant.

Gövde

application/json
customer_id
integer | null

The customer to start the conversation with. When given, channel_id and address may be omitted and are resolved from the customer.

Gerekli aralık: x >= 1
lead_id
integer | null

The lead to start the conversation with, as an alternative to customer_id. The lead's customer record is created if it does not exist yet.

Gerekli aralık: x >= 1
channel_id
integer | null

The channel ID. Required unless customer_id or lead_id is given; otherwise defaults to the customer's preferred reachable channel.

Gerekli aralık: x >= 1
address
string | null

The contact's address on the channel (phone number or channel identifier). Required unless customer_id or lead_id is given.

Maximum string length: 255
contact_type
enum<string> | null

How a contact that is not on record yet is created: customer (a patient, the default) or lead (a lead at the active pipeline's entry stage). Ignored when the address already belongs to a contact.

Mevcut seçenekler:
customer,
lead,
null
first_name
string | null

The first name.

Maximum string length: 255
last_name
string | null

The last name.

Maximum string length: 255

Yanıt

success
string
gerekli
data
ConversationResource · object
gerekli