Sign in

v1

latestOpenAPI 3.1.02026-07-24181585937.4 KB
Openings

opening.update

Updates an opening.

To set values for custom fields on Openings, use the customField.setValue endpoint.

Requires the jobsWrite permission.

post/opening.update

Request body

openingIdstring uuid required

The id of the opening to update

identifierstring nullable

The human-readable identifier of the opening

descriptionstring nullable

The description of the opening

teamIdstring uuid nullable

The id of the department or team associated with the opening

targetHireDatestring nullable

The date (in YYYY-MM-DD format) by which you intend to hire against this opening

targetStartDatestring nullable

The date (in YYYY-MM-DD format) by which you intend someone hired against this opening will start employment

isBackfillboolean nullable

Whether this opening is intended to backfill a previous employee

employmentType'FullTime' | 'PartTime' | 'Intern' | 'Contract' | 'Temporary' nullable

The employment type for this opening

Example request

{
  "openingId": "e9ed20fd-d45f-4aad-8a00-a19bfba0083e",
  "teamId": "e9ed20fd-d45f-4aad-8a00-a19bfba0083e"
}

Response

Responses from the opening.update endpoint

OR

Example response

{
  "success": true,
  "results": {
    "id": "595ae947-e308-4a36-af06-70b7f6e0fb82",
    "openedAt": null,
    "closedAt": null,
    "isArchived": false,
    "closeReasonId": null,
    "archivedAt": null,
    "openingState": "Approved",
    "latestVersion": {
      "id": "3f60be56-95d3-4e5f-a54a-cccfc8056dc2",
      "identifier": "119471",
      "description": "119471",
      "authorId": "eefc52e9-f227-4844-a8a4-9fbfb4a90e5d",
      "createdAt": "2026-04-23T20:32:13.800Z",
      "targetHireDate": null,
      "targetStartDate": null,
      "isBackfill": false,
      "employmentType": "FullTime",
      "teamId": null,
      "jobIds": [],
      "locationIds": [
        "6f5c032e-c14e-4197-94f2-e3218cff8478"
      ],
      "hiringTeam": [],
      "customFields": []
    }
  }
}