Create a new conversation
Create a new conversation. If end_user_id
is not provided, the system creates a new end user automatically. The maximum request size is 10MB, and metadata must not exceed 4KB.
Headers
Authorization
Bearer authentication of the form Bearer <token>, where token is your auth token.
Request
This endpoint expects an object.
channel_id
The ID of the channel to create a conversation in
end_user_id
The ID of the end user participating in the conversation. If not provided, the system will create a new end user automatically.
metadata
A dictionary of key, value pairs assigned to the conversation - metadata
keys may only be of type: string
- metadata
values may only be one of type: string
, boolean
, or integer
Response
Conversation created
id
The ID of the conversation
channel_id
The ID of the channel
end_user_id
The ID of the end user participating in the conversation
status
The status of the conversation
Allowed values:
created_at
The date and time the conversation was created
updated_at
The date and time the conversation was last updated
metadata
A dictionary of key, value pairs assigned to the conversation - metadata
keys may only be of type: string
- metadata
values may only be one of type: string
, boolean
, or integer