conversations

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.

post/v2/conversations/

Request

  • Base URL: https://example.ada.support/api
  • URL: https://example.ada.support/api/v2/conversations/
  • Auth: HTTP bearer

Request body

channel_idstring id required

The ID of the channel to create a conversation in

end_user_idstring id

The ID of the end user participating in the conversation. If not provided, the system will create a new end user automatically.

metadataobject

A dictionary of key value pairs assigned to the conversation. Note: This metadata does not create or set Ada metavariables. To create or update metavariables, use the End Users API.

  • metadata keys may only be of type: string
  • metadata values may only be one of type: string, boolean, integer, or number (float)

Response

Conversation created

idstring id

The ID of the conversation

channel_idstring

The ID of the channel

end_user_idstring id

The ID of the end user participating in the conversation

status'active' | 'ended'

The status of the conversation

created_atstring

The date and time the conversation was created

updated_atstring

The date and time the conversation was last updated

metadataobject

A dictionary of key value pairs assigned to the conversation. Note: This metadata does not create or set Ada metavariables. To create or update metavariables, use the End Users API.

  • metadata keys may only be of type: string
  • metadata values may only be one of type: string, boolean, integer, or number (float)

Changes

No recorded changes to this operation across all 1 revision of this API.