Skip to navigation

Update ticket

Update a ticket’s title, comment, status, priority, and/or assignee. Requires editor access to the ticket’s agent.

Path parameters

agentqa_ticket_idstringRequired

Headers

xi-api-keystringOptional

Request

This endpoint expects an object.
titlestring or nullOptional1-120 characters
If provided, updates the ticket title. Omit to leave unchanged.
statusenum or nullOptional
If provided, updates the ticket status. Omit to leave unchanged.
Allowed values:
assignee_user_idstring or nullOptional
If provided, updates who is responsible for resolving this ticket. Must be a workspace member with at least viewer access to the agent. Pass null to unassign. Omit to leave unchanged.
priorityenum or nullOptional
If provided, updates how urgently the ticket needs attention. Pass null to clear it. Omit to leave unchanged.
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