support_status_archive

Tool

support_status_archive

Retire a status.

Retire a status. There is no way to delete one: every thread on it moves to the target status in the same transaction, so no thread is ever left on an archived status. The target must be a different, live status of this product

Behavior

HTTP: POST /support/statuses/:id/archive

Arguments

Name	Type	Required	Description
id	string	•	Status id
targetStatusId	string	•	Live status every thread on the archived status moves to, in the same transaction

Response

Field	Type	Always	Description
id	string	•	Status id
name	string	•	Status name, unique within the product
color	string	•	Display colour as a hex string
order	integer	•	Sort order within the status dictionary
archived	boolean	•	Archived statuses stay readable but are not offered as targets
category	string	•	Lifecycle bucket the status belongs to

Try it

Retire a status.

When to use

Example

Ask your agent something like this:

Retire a status.

The agent will invoke support_status_archive with these arguments:

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