Skip to main content
POST
Create conversation

Authorizations

Authorization
string
header
default:App
required

This is the most secure authorization type and the one with the most flexibility.

API keys can be generated by calling the dedicated API method. Furthermore, API keys can have a limited scope and cover only some API methods. Lastly, they can be revoked at any time. This range of possibilities makes API keys well suited for separating the API access rights across multiple applications or use cases. Finally, the loss of an API key is easily manageable.

You can manage your API keys from GUI, or programmatically with dedicated API.

API key Authorization header example:

Body

application/json
topic
string

Conversation topic.

Maximum string length: 1000
summary
string

Short description of the conversation.

Maximum string length: 4000
status
enum<string>
default:OPEN

Conversation status.

Available options:
OPEN,
WAITING,
SOLVED,
CLOSED
priority
enum<string>
default:NORMAL

Conversation priority.

Available options:
URGENT,
HIGH,
NORMAL,
LOW
queueId
string

Id of the queue conversation belongs to.

Maximum string length: 255
agentId
string

Id of the agent assigned to the conversation.

Maximum string length: 255

Response

OK

id
string
read-only

Conversation Id.

topic
string

Conversation topic.

Maximum string length: 1000
summary
string

Short description of the conversation.

Maximum string length: 4000
status
enum<string>
default:OPEN

Conversation status.

Available options:
OPEN,
WAITING,
SOLVED,
CLOSED
priority
enum<string>
default:NORMAL

Conversation priority.

Available options:
URGENT,
HIGH,
NORMAL,
LOW
queueId
string

Id of the queue conversation belongs to.

Maximum string length: 255
agentId
string

Id of the agent assigned to the conversation.

Maximum string length: 255
createdAt
string<date-time>
read-only

Time stamp when conversation is created.

updatedAt
string<date-time>
read-only

Time stamp when conversation is updated.

closedAt
string<date-time>
read-only

If conversation is closed, time stamp when is closed.