Sign in

v1

latestOpenAPI 3.1.02026-07-24181585937.4 KB
Offer

offer.start

The offer.start endpoint creates and returns an offer version instance that can be filled out and submitted using the offer.create endpoint.

In order to create a new offer version for a candidate with an in-progress offer process, you can call the offer.start endpoint and then call the offer.create endpoint to fill out the newly created offer version form.

Requires the offersWrite permission.

post/offer.start

Request body

offerProcessIdstring uuid required

The ID of the offer process to start. This value is the id included in the response of the offerProcess.start API.

Example request

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

Response

Responses from the offer.start endpoint

OR

Example response

{
  "success": true,
  "results": {
    "id": "698a9280-0a1d-4e72-acd0-b45c771363e8",
    "formDefinition": {
      "sections": [
        {
          "fields": [
            {
              "isRequired": true,
              "field": {
                "id": "69c5aa80-34c1-4385-88ed-b2b2676e639d",
                "type": "UUID",
                "path": "opening.id",
                "humanReadablePath": "Opening",
                "title": "Opening",
                "isNullable": false
              }
            }
          ]
        }
      ]
    }
  }
}