Update JIE Role

put

https://apiv2.{domain}.ai/api/v2/JIE/roles/{roleId}

Update a role in Eightfold

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

roleId

string

required

ID of a role

Query Params

exclude

string

Exclude specific fields in the response. Possible values are the names of the top level fields present in corresponding API schema. To check API schema, expand the response section below.

keyList

string

Allows selective control over the fields returned in the API response. If the keyList is empty, all fields will be returned. Possible values are the names of the top level fields present in corresponding API schema. To check API schema, expand the response section below.

Body Params

externalId

string | null

external role id for a role

skillProficiencies

array of objects | null

skill proficiencies of the role

skillProficiencies

experience

object | null

preferred experience for the role

idealCandidateUrls

array of strings | null

LinkedIN URL's of preferred/ideal candidates for the role

idealCandidateUrls

education

object | null

preferred education for the role

calibrationNotes

string | null

calibration Notes for a role

roleDescription

string | null

description of the role

idealCandidates

array of strings | null

EF profile ids of preferred/ideal candidates for the role

idealCandidates

associatedTags

array of objects | null

associated tags with the role, these tags are specific to a role and are generally filled in with a unique tag value. Only pre-configured tags in role_library_config:integration_config:configuration_tags are allowed

associatedTags

approvalStatus

string | null

approval status of role, can be one of ['approved', 'unapproved']

locations

array of strings | null

preferred locations for the role

locations

archivalStatus

boolean | null

is archival of role

title

string

required

title of the role

displayTags

array of objects | null

display tags of the role. They may or may not be unique to a role. Only pre-configured tags in role_library_config:integration_config:display_tags are allowed

displayTags

Headers

Authorization

string

required

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

Response

Language

URL

Loading…

Response

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

application/json

200OK