Update an Application

Updates the details of an existing application such as source, stage, or custom fields.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

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 - Required
  • source
  • candidateId
  • candidate.firstName
  • candidate.lastName
  • candidate.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.city
  • candidate.presentAddress.state
  • candidate.presentAddress.country
  • candidate.links[].platform - One of LINKEDIN, GITHUB, WEBSITE, TWITTER, MEDIUM, STACKOVERFLOW; other platforms are ignored
  • candidate.links[].link
  • attachment.fileName
  • attachment.fileContent - Base64-encoded file content; if absent, fileUrl is required
  • attachment.fileUrl - Used to fetch file if fileContent is not provided; required if fileContent is absent
  • attachment.contentType
  • attachment.fileType - Only RESUME is handled; other types are silently ignored
  • metaData.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 - Required
  • jobId - Required
  • candidate
  • candidate.firstName
  • candidate.lastName
  • candidate.phones
  • candidate.emails

Additional Metadata:

  • legallyEligibleToWorkInCountry
  • requireSponsorshipOrAuthorizationForEmploymentInCountry
Recruitee (recruitee)

Remarks:

  • Supported Fields: candidateId, candidate.emails, candidate.phones, candidate.firstName, candidate.lastName, candidate.links, and attachment.
Pinpoint (pinpoint)

Remarks:

  • Supported Fields: applicationId, candidate.emails, candidate.phones, candidate.firstName, candidate.lastName, candidate.presentAddress, candidate.links, and source.
Recruiterflow (recruiterflow)

Supported Request Fields:

  • candidateId - Required
  • candidate.firstName
  • candidate.lastName
  • candidate.emails.email
  • candidate.phones.phoneNumber
  • candidate.links.platform
  • candidate.links.link
  • candidate.tags
  • candidate.presentAddress.addressLine1
  • candidate.presentAddress.addressLine2
  • candidate.presentAddress.city
  • candidate.presentAddress.state
  • candidate.presentAddress.country
  • candidate.presentAddress.zipCode
  • candidate.title
  • candidate.company
  • source
Recruit CRM ATS (recruit-crm-ats)

Supported Request Fields:

  • applicationId - Required
  • jobId
  • initialStageId
  • candidateId
  • candidate.firstName - Required if candidateId is not given
  • candidate.lastName
  • candidate.emails
  • candidate.emails.email- one at the 0th index is honored
  • candidate.phones
  • candidate.phones.phoneNumber - one at the 0th index is honored
  • candidate.links
  • candidate.links.platform - one of LINKEDIN, FACEBOOK, GITHUB, TWITTER, XING
  • candidate.links.link
  • candidate.title
  • candidate.company
  • candidate.presentAddress.addressLine1
  • candidate.presentAddress.addressLine2
  • candidate.presentAddress.city
  • candidate.presentAddress.state
  • candidate.presentAddress.country
  • candidate.presentAddress.zipCode
  • candidate.education
  • answers.question - expects questionId here
  • answers.answer
  • attachment.fileUrl
Jobvite (jobvite)

Supported Request Fields:

  • applicationId - Required
  • initialStageId
  • candidate.firstName
  • candidate.lastName
  • candidate.emails[].email- required , one at the 0th index is honored
  • candidate.phones[].phoneNumber - one at the 0th index is honored
  • candidate.phones[].type
  • candidate.title
  • candidate.presentAddress.addressLine1
  • candidate.presentAddress.addressLine2
  • candidate.presentAddress.city
  • candidate.presentAddress.state
  • candidate.presentAddress.country
  • candidate.presentAddress.zipCode
  • attachment.fileName
  • attachment.fileContent
  • attachment.fileUrl
  • attachment.fileType - honored RESUME , COVER_LETTER
  • source
  • metaData

Remarks:

  • To use this api you must have entered a valid value for the optional field company Id while doing the jobvite integration.
  • To update an application's stage, you must also pass the target stage name in metaData.workflowState.
ERPNext ATS (erpnext-ats)

Body Params
string
required
candidate
object
string
answers
array of objects
answers
attachment
object
string

Source of the application

string
required
string
string

JSON-formatted string containing set of key-value attributes to provide additional data

Responses

Language
Credentials
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json