API Reference

approvalDefinition.update

post
https://api.ashbyhq.com/approvalDefinition.update

Create or update an approval definition for a specific entity that requires approval. The entity requiring approval must be within scope of an approval in Ashby that is marked as being managed by the API.

If the provided approval step definitions is an empty list, then approval will be skipped and the entity will proceed to the next stage.

Requires the approvalsWrite permission.

Body Params
string
enum
required
Allowed:
uuid
required

The id of the approval entity being updated (e.g. the id of the offer version).

approvalStepDefinitions
array of objects
required

An ordered list of approval steps that describes the number of required approvers at each step, as well as who is an approver at each step.

approvalStepDefinitions*
boolean

Control whether an approval request created through this API should be immediately submitted. If false, then the approval will need to be manually submitted in the Ashby app. Default: false

Response

Updated 5 months ago

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