---
title: "Update Custom Ticket Status"
method: PUT
path: "/api/v2/custom_statuses/{custom_status_id}"
tags: ["Custom Ticket Statuses"]
---

# Update Custom Ticket Status

`PUT /api/v2/custom_statuses/{custom_status_id}`

Takes a `custom_status` object that specifies the properties to update.

#### Allowed For

* Admins

## Path parameters

- `custom_status_id` integer, required

## Request body

- CustomStatusUpdateRequest
  - `custom_status` CustomStatusUpdateInput
    - `active` boolean — True if the custom status is set as active; inactive if false
    - `agent_label` string — The dynamic content placeholder, if present, or the "agent_label" value, if not. See [Dynamic Content Items](/api-reference/ticketing/ticket-management/dynamic_content/)
    - `description` string — The dynamic content placeholder, if present, or the "description" value, if not. See [Dynamic Content Items](/api-reference/ticketing/ticket-management/dynamic_content/)
    - `end_user_description` string — The dynamic content placeholder, if present, or the "end_user_description" value, if not. See [Dynamic Content Items](/api-reference/ticketing/ticket-management/dynamic_content/)
    - `end_user_label` string — The dynamic content placeholder, if present, or the "end_user_label" value, if not. See [Dynamic Content Items](/api-reference/ticketing/ticket-management/dynamic_content/)

## Response `200`

Updated

- CustomStatusResponse
  - `custom_status` CustomStatusObject
    - `active` boolean — If true, the custom status is set to active, If false, the custom status is set to inactive
    - `agent_label` string, required — The label displayed to agents. Maximum length is 48 characters
    - `created_at` string, date-time — The date and time the custom ticket status was created
    - `default` boolean — If true, the custom status is set to default. If false, the custom status is set to non-default
    - `description` string — The description of when the user should select this custom ticket status
    - `end_user_description` string — The description displayed to end users
    - `end_user_label` string — The label displayed to end users. Maximum length is 48 characters
    - `id` integer — Automatically assigned when the custom ticket status is created
    - `raw_agent_label` string — The dynamic content placeholder. If the dynamic content placeholder is not available, this is the "agent_label" value. See [Dynamic Content Items](/api-reference/ticketing/ticket-management/dynamic_content/)
    - `raw_description` string — The dynamic content placeholder. If the dynamic content placeholder is not available, this is the "description" value. [Dynamic Content Items](/api-reference/ticketing/ticket-management/dynamic_content/)
    - `raw_end_user_description` string — The dynamic content placeholder. If the dynamic content placeholder is not available, this is the "end_user_description" value. See [Dynamic Content Items](/api-reference/ticketing/ticket-management/dynamic_content/)
    - `raw_end_user_label` string — The dynamic content placeholder. If the dynamic content placeholder is not available, this is the "end_user_label" value. See [Dynamic Content Items](/api-reference/ticketing/ticket-management/dynamic_content/)
    - `status_category` 'new' | 'open' | 'pending' | 'hold' | 'solved', required — The status category the custom ticket status belongs to
    - `updated_at` string, date-time — The date and time the custom ticket status was last updated

---

[API](https://skmtc.dev/botbrains-io/apis/support-api.md) · [All operations](https://skmtc.dev/botbrains-io/apis/support-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/botbrains-io/support-api/revisions/d53eac07ba68/schema)