Applicant Inbox | Payload Examples

Adam Dullage itris Expert

The /api/v2/applicant/inbox API endpoint is a flexible way to send applicant registrations, updates and job applications to itris. This page provides examples of payloads that can be sent to the endpoint. Full details for the endpoint can be found in the Technical Documentation (Swagger).

Data sent to this endpoint is then triaged by itris users using the associated Applicant Inbox feature in itris. Users can choose to use the incoming data to update existing matching applicants or to create new applicants.

Applicant Registration Example

Register a new applicant called John Smith with the following details.

Note: The itris Applicant Inbox will attempt to match the incoming data with existing applicants. If a match is found, the user can choose to update the existing applicant with the new data instead.

{
  "firstName": "John",
  "lastName": "Smith",
  "emailAddress": "john.smith@example.com",
  "phoneNumber": "+44 1892 825820",
  "webAddress": "https://www.linkedin.com/company/itris-recruitment-crm-software/",
  "cv": {
    "fileName": "John Smith CV.docx",
    "fileContent": "Sm9obiBTbWl0aA==",
    "fileDatetime" "2024-01-01T09:58:45.475Z"
  },
  "source": {
    "mediaName": "Website",
    "mediaChannelName": "Registration Page"
  }
}

Email Address Update

Update the email address of applicant 1234 to john.smith@example.com.

{
  "applicantId": 1234,
  "emailAddress": "john.smith@example.com"
}

Job Application - Known Applicant Id

Submit applicant 1234 to job 567 and notify user 84.

{
  "applicantId": 1234,
  "applyToJobIds": [ 567 ],
  "notifyUserIds": [ 84 ]
}

Job Application - Unknown Applicant Id

Submit John Smith to job 567 without knowing the applicant id.

{
  "firstName": "John",
  "lastName": "Smith",
  "applyToJobIds": [ 567 ]
}