Skip to content

Support

support_thread_status_set

Move a thread to a status.

Tool

support_thread_status_set

Move a thread to a status.

Move a thread to a status. Any status may follow any other — there are no transition rules. The category is never a parameter: it comes from the status the thread lands on. A status belonging to another product is reported as not found, and an archived status is refused

Behavior

HTTP
POST /support/threads/:id/status

Arguments

NameTypeRequiredDescription
idstringThread id
statusIdstringDestination status of this product. Any status may follow any other — v1 has no transition rules. An archived status is refused

Response

FieldTypeAlwaysDescription
idstringThread id
typestringticket: the end user wants something fixed. feedback: unsolicited input
titlestringThread subject
labelsarrayEvery label on the thread, by name
ratingintegerThe score the client supplied at creation, or null while the thread is unrated
statusobjectThe status itself, joined in at read time
metadataobjectFree-form client-owned JSON
prioritystringThread priority
statusIdstringId of the status the thread sits on
createdAtstringISO-8601 creation timestamp
updatedAtstringISO-8601 last-modification timestamp
lastReplyAtstringISO-8601 timestamp of the last reply, or null while there are none
authorDisplaystringDisplay name for the external author, if given
assignedAgentIdstringAssigned agent, or null while unassigned
authorExternalIdstringThe external author, byte-identical to what was stored

Try it

Move a thread to a status.

When to use

Move a thread to a status. Any status may follow any other — there are no transition rules. The category is never a parameter: it comes from the status the thread lands on. A status belonging to another product is reported as not found, and an archived status is refused

Example

Ask your agent something like this:

Move a thread to a status.

The agent will invoke support_thread_status_set with these arguments:

{
  "id": "<id>",
  "statusId": "<statusId>"
}

Esc

Start typing to search the docs.

navigateselect