InitializeAtsSyncCandidateSyncApplicationInput

Input Object

Input for the initialize mutation.

---

Fields

applicationIdentifier AtsSyncCandidateSyncApplicationIdentifierInput! Required

Unique ID of the application on Indeed.

indeedRegistrationId ID! Required

Unique ID linking an Indeed employer to a partner employer. Provided during registration.

atsCandidateId ID

Optional ID for a candidate profile associated with one or more applications in the ATS.

atsApplicationId ID! Required

Unique ID for the application in the ATS.

job AtsSyncCandidateSyncJobInput! Required

Information about the job posting. Lets Indeed to associate imported application data with jobs published through the Job Sync API.

sourcedPostingId ID

Unique ID for the job posting.

indeedApplyId ID

Indeed Apply ID of the job application.

ittk ID

Indeed Tracking Token (ITTK) of the job application.

candidateLink WebUrl

Direct link to the candidate profile in the ATS.

applicationLink WebUrl! Required

Direct link to the application in the ATS.

applicationSourceName String

Source of the application, such as a job board, career site, search firm, or social network.

applicant AtsSyncCandidateSyncApplicantDetailsInput! Required

Applicant details.

name String! Required

Full name of the applicant.

streetAddress String

Applicant's street address, including street name and number, city, administrative region, and postal code.

Example (USA): 10721 Domain Dr, Austin, TX 78758 Example (UK): 20 Farringdon Rd, London EC1M 3HE

Used to generate geolocation data. Provide as accurate a value as possible.

postalCode String

Postal code for the applicant's address.

email EmailAddress! Required

Contact email address for the applicant.

phone PhoneNumber

Contact phone number for the applicant.

country CountryCode

Country of residence for the applicant.

attachments [AtsSyncCandidateSyncApplicationAttachmentInput!]! default:[]

File attachments for the application. Can include multiple resumes, cover letters, and other attachments.

Only one RESUME and one COVER_LETTER attachment are allowed. Use OTHER_RESUME and OTHER_COVER_LETTER for additional resumes and cover letters.

Only the RESUME attachment is parsed for applicant matching and ranking.

fileType AtsSyncCandidateSyncApplicationFileTypeInput! Required

Type of file attached to the application, such as a resume, cover letter, or other document.

fileName String! Required

File attachment name.

contentType String! Required

File attachment original media type.

contentLength Int64! Required

Content length of the file attachment.

fileChecksum AtsSyncCandidateSyncApplicationAttachmentChecksumInput! Required

Checksum for verifying file attachment integrity.

Calculate the checksum of the file content using the specified algorithm and format before uploading.

additionalInfo [String!]! default:[]

Additional information about the application that does not fit other categories.

awards [AtsSyncCandidateSyncApplicationAwardInput!]! default:[]

Applicant's awards.

name String

Award name.

description String

Award description.

dateIssued Date

Issue date for the award.

education [AtsSyncCandidateSyncApplicationEducationInput!]! default:[]

Applicant's education history.

degree String

Degree type, such as "Bachelor of Science."

minor String

Minor field of study.

fieldOfStudy String

Major field of study.

school String

School name.

location String

Address of the institution attended.

startDate Date

Date this education began.

endDate Date

Date this education ended.

groups [AtsSyncCandidateSyncApplicationGroupInput!]! default:[]

Applicant's membership in groups.

name String

Group name.

description String

Group description.

startDate Date

Start date of the group membership.

endDate Date

End date of the group membership.

languageProficiencies [AtsSyncCandidateSyncApplicationLanguageProficienciesInput!]! default:[]

Languages known by the applicant.

name LanguageCode! Required

Language name.

proficiency String

Language level of proficiency.

certifications [AtsSyncCandidateSyncApplicationCertificationInput!]! default:[]

Applicant's licenses and certifications.

name String

Certification or license name.

type String

Certification or license type.

description String

Description or additional details about the certification or license.

country CountryCode

Country where the certification or license was obtained.

dateIssued Date

Issue date for the certification or license.

expirationDate Date

Expiration date for the certification or license.

links [AtsSyncCandidateSyncApplicationLinkInput!]! default:[]

Links to social media sites, blogs, and other sites provided by the applicant.

type String

Type of link associated with the URL, such as "X" or "Facebook."

url WebUrl

URL for the applicant's link.

workExperience AtsSyncCandidateSyncApplicationWorkExperienceInput

Applicant's work experience.

mostRelevantTitle String

Most relevant job title held by the applicant.

mostRelevantCompany String

Company associated with the most relevant job title held by the applicant.

workHistory [AtsSyncCandidateSyncApplicationWorkExperienceDetailsInput!]! default:[]

Full employment history for the applicant.

skills [AtsSyncCandidateSyncApplicationSkillInput!]! default:[]

Applicant's skills.

name String

Skill name.

proficiency String

Level of proficiency with the skill.

monthsOfExperience Int

Months of experience with the skill.

military AtsSyncCandidateSyncApplicationMilitaryDetailsInput

Applicant's military commendations.

militaryCommendations String

Military commendations received by the applicant.

militaryServices [AtsSyncCandidateSyncApplicationMilitaryServiceInput!]! default:[]

Details about military service for this applicant.

workAuthorizations [AtsSyncCandidateSyncApplicationWorkAuthorizationInput!]! default:[]

Work authorizations held by the applicant

type AtsSyncCandidateSyncApplicationWorkAuthorizationTypeInput

Type of work authorization.

countryCode CountryCode

ISO country code for the work authorization, such as "US."

countryName String

Human-readable country name for the work authorization, such as "United States."

displayLabel String

Display label for the work authorization, such as "Authorized to work in the US for any employer."

summary String

Text summary of the applicant's profile.

preferredLocale AtsSyncCandidateSyncLocaleInput

Applicant's preferred locale.

language LanguageCode

Preferred language of the applicant.

country CountryCode

Preferred country of the applicant.

questionsAndAnswers [AtsSyncCandidateSyncApplicationQuestionAndAnswerInput!]! default:[]

Screener questions and answers on the application.

id ID! Required

Unique ID for this question.

question String! Required

The question text that applicants see.

answer String

Optional answer to the question.

disposition AtsSyncCandidateSyncApplicationDispositionInput! Required

Disposition status of the application.

dispositionStatus IndeedDispositionStatus! Required

Indeed disposition status mapped from the raw disposition status.

DROPPED_* disposition statuses are rejected. Use these only for applications not persisted by the ATS.

rawDispositionStatus String! Required

Raw application disposition status from the ATS.

rawDispositionDetails String

Optional additional details about the application disposition status from the ATS.

dataModifications [AtsSyncCandidateSyncApplicationDataModificationInput!]! default:[]

Changes the partner made to source data before syncing to Indeed, such as removing an oversized attachment.

Indeed uses this to see how synced application data differs from the partner's ATS data.

action AtsSyncCandidateSyncApplicationDataModificationActionInput! Required

How the partner modified the data.

reason AtsSyncCandidateSyncApplicationDataModificationReasonInput! Required

Why the partner modified the data.

target AtsSyncCandidateSyncApplicationDataModificationTargetInput! Required

Part of the application the partner modified.

index Int

Zero-based index of the item in the target list.

For example, 1 is the second attachment.

Use with any action, including REMOVED when a value is omitted from an item that is still present, such as an answer removed from a screener question.

Set to null when the modification is not tied to a specific item, including when the whole item or target was removed and is not in the provided data.

details String

Human-readable detail, such as an affected file name, if provided.

Indeed does not interpret this value procedurally. Do not include PII.

updatedAt DateTime! Required

Time the application was last updated.

Example

{
  "applicationIdentifier": AtsSyncCandidateSyncApplicationIdentifierInput,
  "indeedApplyId": "opaqueId",
  "ittk": "opaqueId",
  "candidateLink": "https://www.example.com/",
  "applicationLink": "https://www.example.com/",
  "applicationSourceName": "abc123",
  "applicant": AtsSyncCandidateSyncApplicantDetailsInput,
  "questionsAndAnswers": [
    AtsSyncCandidateSyncApplicationQuestionAndAnswerInput
  ],
  "disposition": AtsSyncCandidateSyncApplicationDispositionInput,
  "dataModifications": [
    AtsSyncCandidateSyncApplicationDataModificationInput
  ],
  "updatedAt": "2023-01-01T09:00:00Z"
}

 

Was this page helpful?