Sign in

v1

latestOpenAPI 3.1.02026-07-24181585937.4 KB
Offer

offer.create

Creates a new Offer

Offer forms support a variety of field types. The values accepted for each field depend on the type of field that's being filled out:

  • Boolean - A boolean value.
  • Currency - An object in the format { currencyCode: "USD", value: 100000 } where currencyCode is a valid ISO 4217 currency code and value is an integer.
  • Date - A valid ISO Date string.
  • Number - An integer.
  • String - A string.
  • ValueSelect - A string that matches the value of one of the ValueSelect field's selectable options.
  • MultiValueSelect - An array of strings that exist in the MultiValueSelect field's selectable options.

Error codes:

CodeDescription
opening_in_useThe opening is already in use by another offer.
opening_state_invalidThe opening has already been closed or filled by a different application..

Requires the offersWrite permission.

post/offer.create

Request body

offerProcessIdstring uuid required

The id of the offer process associated with the offer you're creating. This value is the id included in the response of the offerProcess.start API.

offerFormIdstring uuid required

The id of the form associated with the offer. This value is the id included in the response of the offer.start API.

excludeFormDefinitionboolean nullable

If true, omit the form definition from the response.

Example request

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

Response

Responses from the offer.create endpoint

OR

Example response

{
  "success": true,
  "results": {
    "id": "8bd7d0d4-98bb-4bfa-8d42-13b2efd3ba88",
    "decidedAt": null,
    "applicationId": "3d9539db-cd22-4f7f-a8f9-a9d5d1f364dd",
    "acceptanceStatus": "Pending",
    "offerStatus": "WaitingOnApprovalStart",
    "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": []
  }
}