v1

latestOpenAPI 3.0.02026-08-061280285.2 KB
Candidate APIs

Add a candidate record.

<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": "string"<br/>}<br/></li><br/><br/><li> Multi select :<br/>{<br/> "id": multi_select_cf_id,<br/> "value": ["string1", "string2"]<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> Profile :<br/>{<br/> "id": profile_cf_id,<br/> "value": [{"id": profile_id, "type": entity_type(Candidate, Contact, Company)}]<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> Users:<br/>{<br/> "id": users_cf_id,<br/> "value": [integer_user_id_1, integer_user_id_1]<br/>}</li><br/>

post/api/external/candidate/add

Headers

RF-Api-Keystring
content-typestring

Request body

added_timestring
angellist_profilestring
facebook_profilestring
github_profilestring
lead_owner_idinteger
linkedin_profilestring
namestring
organizationstring
skillsstring[]
sourcestring
tagsstring[]
titlestring
twitter_profilestring
websitesstring[]

Response

Auto generated using Swagger Inspector

RESULTstring