Skip to main content
PUT
Update a lead status

Authorizations

Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Headers

X-Tenant
number
required

Tenant identifier. Send the Tenant ID in the X-Tenant header to scope API requests to a specific tenant.

Path Parameters

id
integer
required

The lead status identifier

Body

application/json
name
string

The name.

Maximum string length: 255
color
string | null

A hex color code (e.g. #94a3b8).

Maximum string length: 20
sort_order
integer | null

The sort direction (asc or desc).

Required range: x >= 0
is_default
boolean | null

Whether the record is the default.

is_terminal
boolean | null

Whether this is a terminal status.

Response

success
string
required
data
LeadStatusResource · object
required