Sign in

v1

latestOpenAPI 3.1.02026-07-24181585937.4 KB
Offer

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.

post/offer.startApprovalProcess

Request body

offerVersionIdstring uuid required

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

notestring nullable

Optional note to attach to the approval request

excludeFormDefinitionboolean nullable

If true, omit the form definition from the response.

Example request

{
  "offerVersionId": "e9ed20fd-d45f-4aad-8a00-a19bfba0083e"
}

Response

Responses from the offer.startApprovalProcess endpoint

OR

Example response

{
  "success": true,
  "results": {
    "id": "8bd7d0d4-98bb-4bfa-8d42-13b2efd3ba88",
    "decidedAt": null,
    "applicationId": "3d9539db-cd22-4f7f-a8f9-a9d5d1f364dd",
    "acceptanceStatus": "Created",
    "offerStatus": "WaitingOnOfferApproval",
    "latestVersion": {
      "id": "698a9280-0a1d-4e72-acd0-b45c771363e8",
      "startDate": "2026-05-01",
      "salary": {
        "value": 100000,
        "currencyCode": "USD"
      },
      "createdAt": "2026-04-25T02:07:01.594Z",
      "openingId": "1bdb1c73-6ed5-4fc2-8486-16ce03a57c67",
      "customFields": [],
      "fileHandles": [],
      "approvalStatus": null
    },
    "formDefinition": {
      "sections": [
        {
          "fields": [
            {
              "isRequired": true,
              "field": {
                "id": "69c5aa80-34c1-4385-88ed-b2b2676e639d",
                "type": "UUID",
                "path": "opening.id",
                "humanReadablePath": "Opening",
                "title": "Opening",
                "isNullable": false
              }
            }
          ]
        }
      ]
    },
    "versions": []
  }
}