Position Create

post https://apiv2.{domain}.ai/api/v2/core/positions

To add a new position in the system, send the position information in the payload. positionId will be sent back in case of a successful response

Response

Response body

object

confidential

boolean | null

if the position is confidential or not

hiringManager

object | null

Hiring Manager

string | null

name

string | null

required

Name

groupId

string | null

group id

name

string | null

required

Title of the Position

followers

array of strings | null

all the followers of the position

followers

jobDescription

string | null

Detailed Job Description in a text format

systemId

string | null

system id

positionDisplayId

string | null

display job id

recruiter

object | null

Recruiter

string | null

name

string | null

required

Name

calibrationConfirmedBy

string | null

User who confirmed the calibration

open

boolean | null

if the position is open or not

createdBy

string | null

source of the job

calibrationConfirmedAt

int32 | null

Confirmed timestamp for the calibration

atsData

object | null

ats data of the job

createdAt

int32 | null

required

creation timestamp in epoch format

isPrivate

boolean | null

Indicates if a position is a private posting

businessUnit

string | null

business unit

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

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

object

string | null

name

string | null

required

Name

systemId

string | null

system id

activities

array of objects | null

all the activities related to this positions

activities

object

activityTime

int32 | null

required

activity time in epoch format

activityType

string | null

required

activity type

changeLogs

array of objects | null

all the change logs for the activity

changeLogs

object

newValue

string | null

required

new value

fieldName

string | null

required

field name

prevValue

string | null

required

previous value

message

string | null

required

message for the activity

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

object

questionDependencies

array of objects | null

question dependencies

questionDependencies

object

questionId

string | null

required

question id

questionSource

string | null

question source

choiceValue

string | null

required

choice value

dependencyType

string | null

dependency type

childQuestionIds

array of strings | null

child question ids

childQuestionIds

questionnaireId

string | null

required

questionnaire id

restrictAccess

boolean | null

restrict access

title

string | null

required

job title

recruiter

object | null

required

recruiter

jobPosts

array of objects | null

job postings

jobPosts

object

publishedTime

int32 | null

required

published time in epoch format

expirationTime

int32 | null

expiration time in epoch format

postingTitle

string | null

required

posting title

postingId

string | null

required

posting id

locale

string | null

locale of the ats job post

primaryPost

boolean | null

is primary post

jobDescription

string | null

job description

postedFor

string | null

required

internal for internal jobs, external for external jobs, or all for both.

hiringBand

string | null

hiring band

postingTitle

string | null

posting title

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

companyDescription

string | null

Company description

customFields

object | null

custom fields

Has additional fields

sourcers

array of objects | null

all the recruiters/sourcers related to this positions

sourcers

object

string | null

name

string | null

required

Name

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

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

object

choices

array of objects | null

Question choices

choices

object

label

string | null

label

value

string | null

value

choicesV2

array of objects | null

Question choices V2. It supports language mapping.

choicesV2

object

langMappingList

array of objects | null

lang_mapping_list

langMappingList

object

locale

string | null

locale

label

string | null

label

string | null

label

value

string | null

value

questionId

string | null

required

question_id

help

string | null

help

type

string | null

type of the question. e.g.-choice, numeric or text

question

object | null

question. It supports language mapping.

required

boolean | null

required

locations

array of strings | null

location

locations

positionId

int32 | null

EF Position ID

description

string | null

job description

calibrationData

object | null

calibration data of the job

flags

array of strings | null

flags

graduationYear

string | null

graduationYear

schools

array of strings | null

schools

minExperience

int32 | null

minExperience

workCategories

array of strings | null

workCategories

diversity

array of strings | null

diversity

idealCandidates

array of strings | null

ideal_candidates

idealCandidates

companies

array of strings | null

companies

educationLevel

array of strings | null

different education levels

educationLevel

notes

string | null

notes

relocation

array of strings | null

relocation

skills

array of strings | null

skills

titles

array of strings | null

titles

seniorities

array of strings | null

seniorities

locations

array of strings | null

locations

idealCandidateUrls

array of strings | null

idealCandidatesUrls

idealCandidateUrls

maxExperience

int32 | null

maxExperience

role

object | null

role associated with the position

templates

array of objects | null

all calibration templates associated with the role

templates

object

int32 | null

id of the calibration template

name

string | null

Name of the calibration template

name

string | null

name of the role

positionId

int32 | null

job id

Language

URL


xxxxxxxxxx
1
curl --request POST \
2
     --url https://apiv2.eightfold.ai/api/v2/core/positions \
3
     --header 'accept: application/json' \
4
     --header 'content-type: application/json'

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200OK