Create approval flow

Create a multi-step approval flow on a job (and optionally a specific offer), seeded with the supplied approver groups. Each job allows at most one flow per approval_type: one open_job flow gating job opening, one offer_job flow gating offer creation, and one offer_candidate prototype on the job plus one offer_candidate flow per offer (set offer_id for the latter). The new flow is created in pending status with no emails sent; call POST /v3/approval_flows/{id}/request_approvals to actually start it. Each approver entry may identify a user by user_id, email, or employee_id, but the same user cannot appear in more than one group of the same flow.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
integer
required

Id of the job (hiring plan) this approval flow will gate. References a /v3/jobs row.

integer

Id of the specific offer this approval flow will gate. Only valid (and required) when approval_type is offer_candidate; omit for open_job and offer_job flows.

string
enum
required

What this flow approves. open_job gates opening the job for recruiting, offer_job gates allowing offers to be created on the job, and offer_candidate gates extending an individual offer to a candidate. Each job allows at most one open_job and one offer_job flow; offer_candidate flows exist either as a job-level prototype (no offer_id) or one per offer.

Allowed:
boolean
required

When true, approver groups resolve one at a time in submitted order — only after the current group resolves as approved are the next group's approvers asked. When false, all groups are activated in parallel once the flow is started.

approver_groups
array of objects
required

Ordered tiers of approvers to seed into the new flow. The array's index becomes each group's sort_order (zero-based), so earlier entries are asked first in sequential flows.

approver_groups*
Responses

401

Unauthorized

403

Forbidden

422

Unprocessable Content

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