Create an Application

🚧

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.

AppApp IDRemarks
Greenhousegreenhouse
Leverlever
Workdayworkday-atsCreating an application via candidateId is not supported. candidate object is required
SAP SuccessFactorssuccessfactors-atsinitialStageId is not honored by the app. Please pass any dummy string as initialStageId to create an application

- You must pass country in the metadata object
Oracle Cloud HCMoracle-hcm-ats
WorkableworkableCreating an application via candidateId is not supported. candidate object is required
SmartRecruiterssmartrecruiters-ats
TeamTailorteamTailor
BreezybreezyCreating an application via candidateId is not supported. candidate object is required
Sage Recruitmentsage-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
Bullhornbullhorn
Ashbyashby
UKG Pro Recruitingukgpro-atsinitialStageId is not honored by the app. Please pass any dummy string. You need to pass additional fields inside metaData key for creating Application . Refer UKG Pro ATS
Keka ATSkeka-atsCreating an application via candidateId is not supported. initialStageId is not honored pass any dummy string in place of it.
Zoho Recruitzoho-recruitinitialStageId is not honored , pass dummy string in place of it.
BambooHR ATSbamboohr-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 ATSjazzhr-atsinitialStageIdis not honored by the app. Please pass any dummy string asinitialStageId to create an application
RecruiteerecruiteeinitialStageIdis not honored by the app. Please pass any dummy string asinitialStageId to create an application
Oracle Taleooracle-taleoinitialStageIdis not honored by the app. Please pass any dummy string asinitialStageId to create an application
iCIMSicims
Language
Credentials
Click Try It! to start a request and see the response here!