v4

latestOpenAPI 3.1.02026-08-01139149645.9 KB

Job

Create Job

Creates a Job object with the given values.

post/api/ats/v1/jobs

Headers

x-connector-tokenstring required

Request body

namestring nullable

The name of the job.

descriptionstring nullable

A detailed description of the job.

codestring nullable

The internal or external code that identifies the job.

The current status of the job posting. If the value is not one of the defined enum values, the original value passed through will be returned.

confidentialboolean nullable

Whether the job posting is confidential.

departmentsstring[] nullable

A list of department identifiers associated with the job.

officesstring[] nullable

A list of office identifiers where the job is located.

hiring_managersstring[] nullable

A list of identifiers for hiring managers associated with the job.

recruitersstring[] nullable

A list of identifiers for recruiters associated with the job.

template_idstring nullable

The template id associated with the job.

remote_user_idstring uuid

The remote user's id who is creating the job.

openingsinteger nullable

Number of openings for the job.

Example request

{
  "name": "SOFTWARE ENGINEER",
  "description": "We are looking for a software engineer to join our team.",
  "code": "SE-2021-01",
  "status": "OPEN",
  "template_id": "018b4bfb-5ece-70b1-ad5e-862a9433aa65",
  "remote_user_id": "018b4bfb-5ece-70b1-ad5e-862a9433aa65",
  "openings": 3
}

Response

Successful Response

{"stackTrail":"paths:/api/ats/v1/jobs:post:responses:201:content:application/json:schema","oasType":"schema","type":"unknown"}