API Reference

offer.startApprovalProcess

post
https://api.ashbyhq.com/offer.startApprovalProcess

Starts the approval process for an offer in a "WaitingOnApprovalStart" state. Once started, the approval is sent to the configured approvers.

The offer version ID can be obtained from the offer (e.g. offer.info or offer.list response's latestVersion.id).

Requires the offersWrite permission.

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

The id of the offer version whose approval process should be started.

string

Optional note to attach to the approval request.

boolean
Defaults to false

If true, omits the formDefinition field from the response. Useful for integrations that only consume submitted offer values and don't need the full form schema (which can be large for orgs with many selectable values).

Response

Updated about 1 month ago

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

Updated about 1 month ago