Skip to main content
POST
Start Approval

Supported products

Authorizations

Authorization
string
header
required

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

Path Parameters

objectTypeId
string
required

The unique identifier of the object type for which the approval process is being started.

pipelineId
string
required

The unique identifier of the pipeline for which the approval process is being initiated.

Body

*/*
objectId
integer<int64>
required

The unique identifier of the object for which the approval request is being created. It is an integer formatted as int64.

Response

successful operation

approvalStatus
enum<string>
required

The current approval status of the object. This indicates whether the object is approved, pending approval, or rejected.

Available options:
APPROVED,
NO_APPROVAL_NEEDED,
NOT_APPLICABLE,
PENDING,
REJECTED
createdAt
string<date-time>
required

The date and time when this approval status record was created, in ISO 8601 format.

id
string
required

The unique identifier for this approval status object.

objectId
string
required

The unique identifier of the object whose approval status is being tracked.

objectTypeId
string
required

The type identifier of the object, indicating what kind of object is being approved.

pipelineId
string
required

The unique identifier of the pipeline in which the object is located.

pipelineStageId
string
required

The unique identifier of the pipeline stage where the object currently resides.

updatedAt
string<date-time>
required

The date and time when this approval status record was last updated, in ISO 8601 format.

approvalId
string

The unique identifier for the approval process instance associated with this object.

Last modified on August 3, 2026