Skip to content

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

Name
Type
Required
Description
id
string
•
Thread id
statusId
string
•
Destination status of this product. Any status may follow any other — v1 has no transition rules. An archived status is refused

Response

Field
Type
Always
Description
id
string
•
Thread id
type
string
•
ticket: the end user wants something fixed. feedback: unsolicited input
title
string
•
Thread subject
labels
array
•
Every label on the thread, by name
rating
integer
•
The score the client supplied at creation, or null while the thread is unrated
status
object
•
The status itself, joined in at read time
labelIds
array
•
The same labels as a flat list of ids, in the order labels[] has them. This is the value support_thread_update takes back: a dot-path can name this whole set, while labels.0.id names only the first element
metadata
object
•
Free-form client-owned JSON
priority
string
•
Thread priority
statusId
string
•
Id of the status the thread sits on
createdAt
string
•
ISO-8601 creation timestamp
updatedAt
string
•
ISO-8601 last-modification timestamp
labelNames
array
•
The same labels as a flat list of names, in the order labels[] has them
lastReplyAt
string
•
ISO-8601 timestamp of the last reply, or null while there are none
authorDisplay
string
•
Display name for the external author, if given
assignedAgentId
string
•
Assigned agent, or null while unassigned
authorExternalId
string
•
The 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.

↑↓navigate↵select