You must either provide a candidateId or a candidate object
To create an application, you can either provide a candidateId that pertains to an existing candidate in the ATS, or, alternatively, you can provide the candidate object with candidate details.
If you provide the candidateId, then the candidate object is not mandatory. However, if the candidateIdis not provided, then the candidate object is a required field. If both are provided, then it might lead to the ATS processing the request in an unpredictable manner. Therefore, it is best to provide only one of these, depending on your use case.
While providing the candidate object, please provide the firstName, lastName and at least one valid Email ID in the emails list and at least one valid phone number in the phones list.
Supported Apps
Here are the list of apps that support this API.
App
App ID
Remarks
Greenhouse
greenhouse
Lever
lever
lastName is not honored by lever API
Workday
workday-ats
Fields Not Supported: answers, attachment, candidate.title, candidate.company, candidate.workAddress, and candidate.permanentAddress.
In metaData, countryCodeId field is required.
Either candidateId or candidate is required.
SAP SuccessFactors
successfactors-ats
initialStageId is not honored by the app. Please pass any dummy string as initialStageId to create an application
Either candidateId or candidate is required.
If you are passing the candidate object, the candidate.presentAddress.country field is required.
Fields Not Supported: company, links, candidate.workAddress, and candidate.permanentAddress.
Oracle Cloud HCM
oracle-hcm-ats
Workable
workable
Creating an application via candidateId is not supported. candidate object is required
SmartRecruiters
smartrecruiters-ats
TeamTailor
teamTailor
Breezy
breezy
Creating an application via candidateId is not supported. candidate object is required
Sage Recruitment
sage-ats
Creating an application via candidateId is not supported. candidate object is required
Bullhorn
bullhorn
Ashby
ashby
UKG Pro Recruiting
ukgpro-ats
initialStageId is not honored by the app. Please pass any dummy string. You need to pass additional fields inside metaData key for creating Application . Refer
Creating an application via candidateId is not supported. initialStageId is not honored pass any dummy string in place of it.
Zoho Recruit
zoho-recruit
initialStageId is not honored , pass dummy string in place of it.
BambooHR ATS
bamboohr-ats
Creating an application via candidateId is not supported. candidate object is required
initialStageId is not honored by the app. Please pass any dummy string as initialStageId to create an application
JazzHR ATS
jazzhr-ats
initialStageIdis not honored by the app. Please pass any dummy string asinitialStageId to create an application
Recruitee
recruitee
initialStageIdis not honored by the app. Please pass any dummy string asinitialStageId to create an application
Oracle Taleo
oracle-taleo
initialStageIdis not honored by the app. Please pass any dummy string asinitialStageId to create an application
iCIMS
icims
Loxo
loxo
Creating an application via candidateId is not supported. candidate object is required
initialStageId is not honored by the app. Please pass any dummy string
lastName is not honored pass dummy string and in firstname give fullname.
- metaData should contain resume details as it is compulsory. Refer- Create Loxo Application
Pinpoint
pinpoint
Creating an application via candidateId is not supported. candidateobject is required
Language
Credentials
Click Try It! to start a request and see the response here!