Sign in

v1

latestOpenAPI 3.1.02026-07-24181585937.4 KB
Job

job.create

Creates a new job.

Requires the jobsWrite permission.

post/job.create

Request body

titlestring required

The title of the job

teamIdstring uuid required

The id of the department or team associated with the job

locationIdstring uuid required

The id of the location associated with the job

defaultInterviewPlanIdstring uuid nullable

The id of the default interview plan for this job. A job cannot be opened without a default interview plan.

jobTemplateIdstring uuid nullable

The id of the job template to use for this job. Only active job templates can be used to create a job.

brandIdstring uuid nullable

The id of the brand to use for this job

Example request

{
  "title": "Software Engineer",
  "teamId": "e9ed20fd-d45f-4aad-8a00-a19bfba0083e",
  "locationId": "e9ed20fd-d45f-4aad-8a00-a19bfba0083e",
  "defaultInterviewPlanId": "e9ed20fd-d45f-4aad-8a00-a19bfba0083e",
  "jobTemplateId": "e9ed20fd-d45f-4aad-8a00-a19bfba0083e",
  "brandId": "e9ed20fd-d45f-4aad-8a00-a19bfba0083e"
}

Response

Responses from the job.create endpoint

OR

Example response

{
  "success": true,
  "results": {
    "id": "1be42b8e-cafd-4beb-8121-f4981eb20f42",
    "title": "Software Engineer",
    "confidential": false,
    "status": "Draft",
    "employmentType": "FullTime",
    "locationId": "3ae2b801-19f6-41ef-ad28-214bd731948f",
    "departmentId": "f9e52a51-a075-4116-a7b8-484deba69004",
    "defaultInterviewPlanId": "595ae947-e308-4a36-af06-70b7f6e0fb82",
    "interviewPlanIds": [
      "595ae947-e308-4a36-af06-70b7f6e0fb82"
    ],
    "jobPostingIds": [],
    "customRequisitionId": "ENG-01",
    "brandId": "e9ed20fd-d45f-4aad-8a00-a19bfba0083e",
    "hiringTeam": [],
    "customFields": [],
    "createdAt": "2024-01-01T00:00:00.000Z",
    "updatedAt": "2024-01-15T10:30:00.000Z",
    "openedAt": null,
    "closedAt": null
  }
}