Skip to main content
PATCH
Update a custom status

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

id
string<uuid>
required

The custom status id

Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$

Body

application/json
name
string

Internal name shown to agents (unique per organization, 1-100 chars)

Required string length: 1 - 100
description
string

Internal note for agents on when to use this status

parent_status
enum<string>

Built-in status this custom status refines: "open", "closed_resolved", or "closed_unresolved". Applying the custom status to a session moves the session to this built-in status, so an "open"-parented status reopens a closed session and a "closed_*"-parented one closes it. Moving a status across the open/closed boundary drops its ticketing-system stage mappings.

Available options:
closed_resolved,
closed_unresolved,
open
display_name
string | null

Customer-facing label (max 100 chars). null clears it back to name; omit to leave unchanged.

Maximum string length: 100
display_description
string | null

Customer-facing explanation. null clears it; omit to leave unchanged.

color
string | null

Badge color as #RRGGBB. null restores the parent status color; omit to leave unchanged.

Pattern: ^#[0-9a-fA-F]{6}$
icon
string | null

Inline SVG markup for the badge icon. null restores the default icon; omit to leave unchanged.

Maximum string length: 10000
Pattern: ^<svg[\s>]

Response

Default Response

id
string
required
org_id
string
required
name
string
required
description
string | null
required
display_name
string | null
required
display_description
string | null
required
color
string | null
required
icon
string | null
required
parent_status
enum<string>
required
Available options:
closed_resolved,
closed_unresolved,
open
created_at
string<date-time>
required
updated_at
string<date-time>
required