v1

latestOpenAPI 3.0.22026-07-26191278525.6 KB

ATS Position

Patch ATS Position

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.

patch/api/v2/core/ats-systems/{systemId}/ats-positions/{atsPositionId}

Path parameters

atsPositionIdstring required

ATS entity ID of position

systemIdstring required

System ID of position

Headers

Authorizationstring required

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

Request body

createdAtinteger nullable required

creation timestamp in epoch format

locationCountrystring nullable

Country of the location

businessUnitstring nullable

business unit

isPrivateboolean nullable

Indicates if a position is a private posting

workLocationOptionstring nullable

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

atsEntityIdstring nullable required

position_id in the ats system

internalPostingUrlstring nullable

internal posting url

evergreenboolean nullable

is evergreen

skillsstring[] nullable

skills

companystring nullable required

company

locationCitystring nullable

City of the location

lastUpdatedinteger nullable required

last modified date time in epoch format

displayJobIdstring nullable

display job id

startDatestring nullable

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

requisitionTypestring nullable

Requisition Type

systemIdstring nullable

system id

postedForstring nullable

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

restrictAccessboolean nullable

restrict access

titlestring nullable required

job title

templateIdinteger nullable

Template id of the template used to create the position

hiringBandstring nullable

hiring band

postingTitlestring nullable

posting title

employmentTypestring nullable

Employment Type

postedboolean nullable required

status of the position posted or not

locationFlexibilitystring nullable

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

orgUnitsobject nullable

Org units of the position

companyDescriptionstring nullable

Company description

customFieldsobject nullable

custom fields

workflowTemplateIdstring nullable

Indicates which workflow this position belongs to

statusstring nullable required

status

jobCodestring nullable

ATS attribute which identifies the job this jobrequestion is mapped to

openboolean nullable required

status of the position open or not

postingUrlstring nullable

posting url

createdBystring nullable

Email of the user who created this position

functionstring nullable

job function

jobStagesstring[] nullable

job_stages

requiredSkillsstring[] nullable

required skills

locationStatestring nullable

State of the location

locationsstring[] nullable

location

positionIdinteger nullable

EF Position ID

descriptionstring nullable

job description

Response