Skip to main content
PATCH
Update status

Path Parameters

statusRef
string
required

A status, by ID or by name. Names match ignoring case and accents. When a value is one status's ID and another's name, the ID wins.

Body

application/json

Omitted fields are left unchanged, and null clears a nullable field.

name
string
Minimum string length: 1
color
string | null

Null for no color.

Minimum string length: 1
Example:

"blue"

Response

A pipeline stage on the team's board. A contact has at most one status.

A pipeline stage on the team's board. A contact has at most one status.

id
string
required
name
string
required

Unique within the team, ignoring case and accents.

color
string | null
required

Null when the status has no color.

Example:

"#3b82f6"

createdAt
string<date-time>
required
Example:

"2026-09-14T10:32:00.000Z"