Update a lead status
Rename a lead status or change its color. Send label on every update, even when you only change color. Leads that use the status keep it, and show the new label. Returns 400 if another status already has the same label (ignoring case). Requires the Manage Customizations permission, otherwise returns 403.
To change the status of a particular lead, see PUT /lead/{lead_id}/.
Authentication
AuthorizationBasic
Use your API key as the username and leave the password empty.
OR
AuthorizationBearer
Bearer authentication of the form Bearer <token>, where token is your auth token.
Path parameters
id
ID of the lead status.
Request
This endpoint expects an object.
label
Name of the lead status. Leading and trailing whitespace is removed. Must be unique within the organization (ignoring case).
color
Color of the status badge in Close. Set to null to clear the color. On update, leave it out to keep the current color.
Response
Successful response
color
Color of the status badge in Close, or null if no color is set.
id
Unique ID of the lead status, prefixed with stat_.
label
Name of the lead status, unique within the organization (ignoring case).
organization_id
ID of the organization the lead status belongs to.
Errors
400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
429
Too Many Requests Error