job.startApprovalProcess

Starts the approval process for a job. Creates an approval instance and
submits it to the configured approvers.

If an approval process instance is already pending for the job, returns
an error rather than creating a duplicate.

Error codes:

CodeDescription
insufficient_permissionsThe approvals API is not enabled for the organization.
job_not_foundNo job exists with the given ID, or the API key cannot access it.
approval_process_instance_already_pendingAn approval for this job is already pending.
job_approval_definition_not_configuredNo approval definition matches this job.
job_cannot_be_opened_due_to_validationThe job failed approval validation. The errors array includes the validation detail.

Requires the approvalsWrite permission.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
uuid
required
^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$

The id of the job whose approval process should be started

note
object

Optional note to attach to the approval request using { type: "text/plain" | "text/html", value }.

Response

Language
Credentials
Basic
base64
:
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json