Run an Offer from Start to Approval

Run an Offer from Start to Approval

Start, fill, submit, and approve an offer for an application.

1. Start the offer process on the application. This is the container every later call hangs off; its id is required by offer.start and offer.create.
2. Create an offer version instance and return its form definition. This is the step that hands back the field paths the offer form must be filled with — offer.create cannot be composed without reading it first.
3. Submit the filled offer form against the version opened above. The fieldSubmissions paths must match the form definition or Ashby rejects the offer.
4. Start the approval process for the submitted offer version, routing it to whoever the organization's approval definition names.
5. Approve the offer version. This mirrors the "Force Approve" behavior in the Ashby app, where an admin can override the approval chain, so it should be wired only to callers entitled to do that.
6. Read the offer back to confirm its final status. The form definition is excluded here because the caller already has it from openOfferVersion and it is a large payload.

What you'll need to have ready

• applicationId: The id of the application to start an offer process for.
• fieldSubmissions: The completed offer form fields, each an object with a path and a value. The paths must come from the form definition returned by the openOfferVersion step.
• approvalNote: A note to attach when starting the approval process.
• approverUserId: The id of the user to approve as. Omit to approve as the API key user.

For your developer

Arazzo workflow ashby-hq:offer-process, 6 operations: offerProcess.start → offerStart → offerCreate → offerStartApprovalProcess → offerApprove → offerInfo. Specs on APIs.io.