v1

latestOpenAPI 3.0.02026-08-061280285.2 KB
Job APIs

Create a new job.

<br/><b>Please find the input format details below.</b><br/><li> about_position:<br/> Job Description<br/></li><br/><br/><li> client_company_id:<br/> Please refer to the list of clients in client list api in the doc.<br/></li><br/><br/><li> created_by:<br/> Id of the user creating the job.<br/></li><br/><br/><li> department_id:<br/> Find the list of department ids in Other APIS.<br/></li><br/><br/><li> employment_type_id:<br/> Find the list of employment type ids in Other APIS.<br/></li><br/><br/><li> locations:<br/> Array of location ids, get the list of locations from /api/external/location/list API.<br/></li><br/><br/><li> title:<br/> Job title.<br/></li><br/><br/><b>Please find the format of custom field input below.</b><br/><li> Single select:<br/>{<br/> "id": single_select_cf_id,<br/> "value": choice id (get the list from candidate/custom-field/list)<br/>}<br/></li><br/><br/><li> Multi select :<br/>{<br/> "id": multi_select_cf_id,<br/> "value": [choice id1, choice id2] (get the list from candidate/custom-field/list)<br/>}<br/></li><br/><br/><li> Short/Long text:<br/>{<br/> "id": short_text_cf_id,<br/> "value": "text"<br/>}</li><br/><br/><li> Money:<br/>{<br/> "id": money custom field id,<br/> "value": {"number": Integer(The amount), "currency": "string(Currency code eg. USD, GBP)"}<br/>}<br/><br/><li> Money Range:<br/>{<br/> "id": money reange custom field id,<br/> "value": {"number1": Integer(Starting Amount), "number2": "Ending Amount", "currency": "string(Currency code eg. USD, GBP)"}<br/>}<br/><br/><li> Number/Date:<br/>{<br/> "id": cf_id,<br/> "value": number/date to store<br/>}<br/></li><br/><br/><li> Yes No:<br/>{<br/> "id": yes_no_cf_id,<br/> "value": 0 for No and 1 for Yes<br/>}</li><br/><br/><li> Parent-Child :<br/>{<br/> "id": parent-child-cf-id,<br/> "value": [{"name": "parent_name", "children": ["child1", "child2"]}]<br/>}</li><br/><br/><li> Profile:<br/>{<br/> "id": profile_cf_id,<br/> "value": [{"type": "candidate", "id": candidate_id}]<br/>}</li><br/><br/><li> Users:<br/>{<br/> "id": users_cf_id,<br/> "value": [integer_user_id_1, integer_user_id_1]<br/>}</li><br/><br/>

post/api/external/job/create

Headers

RF-Api-Keystring
content-typestring

Request body

about_positionstring
added_timestring
client_company_idinteger

Please refer to the list of clients in client list api in the doc.

contactsinteger[]

Find the list of contact ids in contact list API.

created_byinteger

Id of the user creating the job.

department_idinteger

Find the list of department ids in Other APIS.

employment_type_idinteger

Find the list of employment type ids in Other APIS.

experience_range_endinteger
experience_range_startinteger
locationsinteger[]
number_of_openingsinteger
salary_range_endnumber
salary_range_startnumber
skillsstring[]
titlestring

Response

Auto generated using Swagger Inspector