Skip to main content
PATCH
Update stage (Partial)

Supported products

Authorizations

Authorization
string
header
required

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

Path Parameters

objectType
string
required

The type of object that the pipeline belongs to, such as deals or tickets.

pipelineId
string
required

The unique identifier of the pipeline that contains the stage to be updated.

stageId
string
required

The unique identifier of the stage to update within the specified pipeline.

Body

application/json
metadata
object
required

An object containing additional properties related to the pipeline stage, where each property is a string.

archived
boolean

A boolean indicating whether the pipeline stage is archived.

displayOrder
integer<int32>

An integer specifying the order in which the stage appears relative to other stages.

label
string

A string representing the name or title of the pipeline stage.

Response

successful operation

archived
boolean
required

A boolean indicating whether the stage is archived.

createdAt
string<date-time>
required

The date and time when the stage was created, in ISO 8601 format.

displayOrder
integer<int32>
required

An integer indicating the position of this stage within the pipeline, determining its order relative to other stages.

id
string
required

A unique string identifier for the pipeline stage.

label
string
required

The name or title of the pipeline stage, represented as a string.

metadata
object
required

An object containing additional metadata for the stage, with string values for each property.

updatedAt
string<date-time>
required

The date and time when the stage was last updated, in ISO 8601 format.

writePermissions
enum<string>
required

A string indicating the write permissions for the stage. Valid values include 'CRM_PERMISSIONS_ENFORCEMENT', 'READ_ONLY', and 'INTERNAL_ONLY'.

Available options:
CRM_PERMISSIONS_ENFORCEMENT,
INTERNAL_ONLY,
READ_ONLY
archivedAt
string<date-time>

The date and time when the stage was archived, in ISO 8601 format.

Last modified on October 29, 2026