Skip to main content
PATCH
/
statuses
/
{statusId}
Update status
curl --request PATCH \
  --url https://inboxapp.com/api/v1/statuses/{statusId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "color": "<string>"
}
'
{
  "id": "<string>",
  "name": "<string>",
  "color": "#ef4444",
  "createdAt": "2023-11-07T05:31:56Z"
}

Authorizations

​
Authorization
string
header
required

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

Path Parameters

​
statusId
string
required

The ID of the status to update.

Body

application/json
​
name
string

The new name for the status. Must be unique within the team. Maximum 255 characters.

Required string length: 1 - 255
Examples:

"New Lead"

"Warm"

"Qualified"

"Closed Won"

​
color
string

Color value. Can be a hex code (e.g., #3b82f6) or a color name (e.g., 'blue', 'red'). Use the /colors endpoint to get available color names.

Examples:

"#3b82f6"

"blue"

"red"

"#f59e0b"

Response

200 - application/json

OK

​
id
string
required

Unique identifier for the status.

Example:

"l44e15irdq4db30i77cgphhx"

​
name
string
required

The display name of the status. Typically represents a stage in your sales pipeline.

Examples:

"New Lead"

"Warm"

"Qualified"

"Closed Won"

​
color
string | null
required

Hex color code for the status (e.g., #10b981 for green). Null if no color is set.

Example:

"#ef4444"

​
createdAt
string<date-time>
required

The timestamp when this status was created.

Example:

"2025-11-10T18:03:16.000Z"