Patch ATS Position

patch

https://apiv2.{domain}.ai/api/v2/core/ats-systems/{systemId}/ats-positions/{atsPositionId}

Given an ats position id and data that needs to be patched, it patches the ats position. Note: All required body params in the schema are not enforced in PATCH request, unlike path params.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

atsPositionId

string

required

ATS entity ID of position

systemId

string

required

System ID of position

Body Params

createdAt

int32 | null

required

creation timestamp in epoch format

locationCountry

string | null

Country of the location

coordinators

array of objects | null

all the coordinators related to this position

coordinators

businessUnit

string | null

business unit

isPrivate

boolean | null

Indicates if a position is a private posting

workLocationOption

string | null

Indicates the option for working location e.g. onsite, remote_global, remote_local, hybrid

atsEntityId

string | null

required

position_id in the ats system

hiringManager

object | null

Hiring Manager

internalPostingUrl

string | null

internal posting url

evergreen

boolean | null

is evergreen

skills

array of strings | null

skills

company

string | null

required

company

locationCity

string | null

City of the location

lastUpdated

int32 | null

required

last modified date time in epoch format

displayJobId

string | null

display job id

openings

object | null

Openings

followers

array of objects | null

all the followers of the positions as hiring managers etc.

followers

startDate

string | null

start date of the position in ISO 8601 format (e.g. 2024-05-01)

requisitionType

string | null

Requisition Type

systemId

string | null

system id

activities

array of objects | null

all the activities related to this positions

activities

postedFor

string | null

internal for internal jobs, external for external jobs, or all for both. Can be omitted for unposted positions.Input values must be one of these: internal, external, all, None

questionnaires

array of objects | null

questionnaires

restrictAccess

boolean | null

restrict access

title

string | null

required

job title

templateId

int32 | null

Template id of the template used to create the position

recruiter

object | null

required

recruiter

jobPosts

array of objects | null

job postings

jobPosts

hiringBand

string | null

hiring band

postingTitle

string | null

posting title

employmentType

string | null

Employment Type

posted

boolean | null

required

status of the position posted or not

locationFlexibility

string | null

Indicates the flexibility on location e.g. not_flexible, flexible_within_country, flexible_global

orgUnits

object | null

Org units of the position

companyDescription

string | null

Company description

customFields

object | null

custom fields

sourcers

array of objects | null

all the recruiters/sourcers related to this positions

sourcers

workflowTemplateId

string | null

Indicates which workflow this position belongs to

status

string | null

required

status

jobCode

string | null

ATS attribute which identifies the job this jobrequestion is mapped to

open

boolean | null

required

status of the position open or not

postingUrl

string | null

posting url

atsUserGroups

array of objects | null

ATS user groups

atsUserGroups

createdBy

string | null

Email of the user who created this position

function

string | null

job function

jobStages

array of strings | null

job_stages

jobStages

requiredSkills

array of strings | null

required skills

requiredSkills

questions

array of objects | null

questions

locationState

string | null

State of the location

locations

array of strings | null

location

locations

description

string | null

job description

Headers

Authorization

string

required

The secret key to access the api. It starts with the bearer token

Response

200OK