Skip to content

support_status_create

Add a status to this product status dictionary.

Tool

support_status_create

Add a status to this product status dictionary.

Add a status to this product status dictionary. The name is what people see; the category is what automation and reporting read, and it cannot change once threads sit on the status

Behavior

HTTP
POST /support/statuses

Arguments

Name
Type
Required
Description
name
string
•
Status name as the customer wants to see it. Unique within the product
color
string
•
Display colour as a six-digit hex string, e.g. #2563eb
order
integer
•
Sort order within the status dictionary, lowest first
category
string
•
Lifecycle bucket the status belongs to. Automation and reporting read the category, never the name — so it cannot be changed once threads sit on the status

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

Add a status to this product status dictionary.

When to use

Add a status to this product status dictionary. The name is what people see; the category is what automation and reporting read, and it cannot change once threads sit on the status

Example

Ask your agent something like this:

Add a status to this product status dictionary.

The agent will invoke support_status_create with these arguments:

{
  "name": "<name>",
  "color": "<color>",
  "order": "<order>",
  "category": "<category>"
}

Esc

Start typing to search the docs.

↑↓navigate↵select