API Reference

offer.reject

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

Rejects the current step in an offer's approval process.

Provide the current approval step and an approver from approval.list.
Rejecting the step rejects the approval process and cancels the offer. This is distinct from
recording that a candidate declined an extended offer, which is handled by offer.setStatus.

Requires the offersWrite 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 offer version to reject. This can be obtained as the entityId from the approval.list endpoint.

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 current approval step. This can be obtained from the approval.list endpoint.

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 a user who is an approver for the current approval step.

An optional comment to record with the rejection.

If true, omit the form definition from the response.

Response

Updated about 1 hour 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 hour ago