Skip to navigation

Create conversation ticket

Raise a ticket about an agent’s performance on a conversation, for triage with Architect. Provide an overall comment and/or turn-level comments describing what went wrong.

Headers

xi-api-keystringOptional

Request

This endpoint expects an object.
conversation_idstringRequired
Conversation this ticket is about.
titlestring or nullOptional1-120 characters

One-line headline shown in the triage list. Defaults to one derived from the comments, falling back to the conversation’s summary title. Ignored when the comment is added to the conversation’s open ticket.

qa_commentstring or nullOptional1-10000 characters
The issue this ticket is about, covering the whole conversation rather than a single turn.
turn_commentslist of objectsOptional

Optional turn-level comments on what went wrong.

priorityenum or nullOptional
How urgently the ticket needs attention. If the conversation already has an open ticket, it is raised to this priority when lower.
Allowed values:

Response

Successful Response
agentqa_ticket_idstring
workspace_idstring
owner_user_idstring
agent_idstring
needs_clusteringboolean
titlestring or null

One-line headline for the ticket. None only on tickets created before titles existed.

issue_typeenum or null
labelslist of strings
conversation_idslist of strings
first_seen_unix_secsinteger or null
last_seen_unix_secsinteger or null
qa_commentstring or null
ticket_commentslist of objects
turn_commentslist of objects
statusenum
Allowed values:
priorityenum or null
Allowed values:
priority_changeslist of objects
sourceenum
Allowed values:
assignee_user_idstring or null
created_at_unix_secsinteger
updated_at_unix_secsinteger
merged_into_ticket_idstring or nullOptional
The ticket this one was merged into, set while its status is 'merged'.
search_matchobject or nullOptional

Where the list’s search query matched. Set only on searched lists.

Errors

422
Unprocessable Entity Error