Updates the details of an existing application such as source, stage, or custom fields.
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
Supported Apps
Here are the list of apps that support this API.
Greenhouse (greenhouse)
Remarks: answers, attachment,initialStageId,education, workAddress, jobId and permanentAddress fields are not supported.
Lever (lever)
Remarks: Supported fields: application source and candidate links
Workday (workday-ats)
Remarks: Supported fields: firstName, lastName, phones, links, tags, and presentAddress. In tag list a valid candidate tag Id must be entered.
Workable (workable)
Remarks: workAddress, permanentAddress, company, initialStageId, answers, jobId and source fields are not supported.
TeamTailor (teamTailor)
Remarks: Supported fields: firstName, lastName, phones, emails, tags, links, and attachment. Note: Attachments only support the fileUrl field and the RESUME fileType.
Ashby (ashby)
Supported Request Fields:
applicationId- RequiredsourcecandidateIdcandidate.firstNamecandidate.lastNamecandidate.emails[].email- Array; only the first entry's email is set as primary and remaining is assigned as * alternate emails.candidate.phones[].phoneNumber- Array; only the first entry's phoneNumber is honored.candidate.presentAddress.citycandidate.presentAddress.statecandidate.presentAddress.countrycandidate.links[].platform- One of LINKEDIN, GITHUB, WEBSITE, TWITTER, MEDIUM, STACKOVERFLOW; other platforms are ignoredcandidate.links[].linkattachment.fileNameattachment.fileContent- Base64-encoded file content; if absent, fileUrl is requiredattachment.fileUrl- Used to fetch file if fileContent is not provided; required if fileContent is absentattachment.contentTypeattachment.fileType- Only RESUME is handled; other types are silently ignoredmetaData.application- JsonObject , application specific key value pairs, that are pass as it is to the native api.metaData.candidate- JsonObject , candidate specific key value pairs, that are pass as it is to the native api.metaData.attachment- JsonObject , attachment specific key value pairs, that are pass as it is to the native api.
Remarks: title, company, tags, education, workAddress, permanentAddress, initialStageId, jobId and education fields are not supported.
Zoho Recruit (zoho-recruit)
Remarks: workAddress, permanentAddress, company, initialStageId, answers, attachment, jobId and source fields are not supported.
Vincere (vincere)
Remarks: metaData.document_type_id is a required field if you are adding a attachment. For possible values of document_type_id refer passthrough requests.
JobAdder (jobadder)
Breezy (breezy)
iCIMS (icims)
Keka ATS (keka-ats)
Supported Request Fields:
applicationId- RequiredjobId- Requiredcandidatecandidate.firstNamecandidate.lastNamecandidate.phonescandidate.emails
Additional Metadata:
legallyEligibleToWorkInCountryrequireSponsorshipOrAuthorizationForEmploymentInCountry
Recruitee (recruitee)
Remarks:
- Supported Fields:
candidateId,candidate.emails,candidate.phones,candidate.firstName,candidate.lastName,candidate.links, andattachment.
Pinpoint (pinpoint)
Remarks:
- Supported Fields:
applicationId,candidate.emails,candidate.phones,candidate.firstName,candidate.lastName,candidate.presentAddress,candidate.links, andsource.
Recruiterflow (recruiterflow)
Supported Request Fields:
candidateId- Requiredcandidate.firstNamecandidate.lastNamecandidate.emails.emailcandidate.phones.phoneNumbercandidate.links.platformcandidate.links.linkcandidate.tagscandidate.presentAddress.addressLine1candidate.presentAddress.addressLine2candidate.presentAddress.citycandidate.presentAddress.statecandidate.presentAddress.countrycandidate.presentAddress.zipCodecandidate.titlecandidate.companysource
Recruit CRM ATS (recruit-crm-ats)
Supported Request Fields:
applicationId- RequiredjobIdinitialStageIdcandidateIdcandidate.firstName- Required if candidateId is not givencandidate.lastNamecandidate.emailscandidate.emails.email- one at the 0th index is honoredcandidate.phonescandidate.phones.phoneNumber- one at the 0th index is honoredcandidate.linkscandidate.links.platform- one of LINKEDIN, FACEBOOK, GITHUB, TWITTER, XINGcandidate.links.linkcandidate.titlecandidate.companycandidate.presentAddress.addressLine1candidate.presentAddress.addressLine2candidate.presentAddress.citycandidate.presentAddress.statecandidate.presentAddress.countrycandidate.presentAddress.zipCodecandidate.educationanswers.question- expects questionId hereanswers.answerattachment.fileUrl
Jobvite (jobvite)
Supported Request Fields:
applicationId- RequiredinitialStageIdcandidate.firstNamecandidate.lastNamecandidate.emails[].email- required , one at the 0th index is honoredcandidate.phones[].phoneNumber- one at the 0th index is honoredcandidate.phones[].typecandidate.titlecandidate.presentAddress.addressLine1candidate.presentAddress.addressLine2candidate.presentAddress.citycandidate.presentAddress.statecandidate.presentAddress.countrycandidate.presentAddress.zipCodeattachment.fileNameattachment.fileContentattachment.fileUrlattachment.fileType- honored RESUME , COVER_LETTERsourcemetaData
Remarks:
- To use this api you must have entered a valid value for the optional field
company Idwhile doing the jobvite integration. - To update an application's stage, you must also pass the target stage name in
metaData.workflowState.

