Skip to main content
PUT
Update an organization lead status

Authorizations

Authorization
string
header
required

Authorization header using the Bearer scheme. Accepted values are Leadping user JWT access tokens and WorkOS organization API keys beginning with sk_.

Path Parameters

id
string
required

The unique identifier of the lead status to update.

Body

The replacement lead status name, color, and display order.

Defines the editable values used to create or update a lead status.

name
null | string

Display name for the lead status.

color
null | string

Display color for the lead status.

category
null | enum<string>

Controlled lead status change categories used for reporting, automation, and analytics.

Available options:
Open,
Qualified,
Converted,
Lost,
Invalid,
Duplicate
sortOrder
null | integer<int32>

Relative display order for the lead status.

Response

OK

Describes an organization-defined lead status used to classify pipeline progress, drive automation, and report lifecycle outcomes.

id
string

Unique identifier for the lead status.

organizationId
string

Identifier of the organization that owns the lead status.

name
string

Display name of the lead status.

color
string

Display color assigned to the lead status.

category
enum<string>

LeadStatusChange category represented by the lead status.

Available options:
Open,
Qualified,
Converted,
Lost,
Invalid,
Duplicate
sortOrder
integer<int32>

Relative display order of the lead status.

isArchived
boolean

Indicates whether the lead status has been archived.

modifiedAt
string<date-time>

Date and time when the lead status was last modified.