Partager via

Sync Candidate Notes

  • Article

Candidate notes should be sent via the Middleware Platform whenever they are created or updated in your ATS. Use both your candidate identifier and note identifier when syncing candidate notes via API.

Throttle Limits

Throttle Limits Requests Per Day (UTC) Records Per Minute
Application maximum 100,000 10,000

Note

Please submit batch calls grouped with no more than 100 records in sequential order.

Sync Candidate Notes

Use the following endpoint to create and update candidate notes:

PUT https://api.linkedin.com/v2/atsCandidates/atsCandidateId={your candidate id}&dataProvider=ATS&integrationContext=urn:li:organization:2414183/notes?ids={note id 1}&ids={note id 2}

Request Body Fields

Field Description Format Required
atsCreatedAt Date record was created in your ATS UTC Epoch Milliseconds No
author The first and last name of the person who wrote the note Actor No
note A note about the candidate string No

Actor Schema

Field Description Format Required
firstName The first name of the actor. String Required
lastName The last name of the actor String Required

Sample Request

Headers:

Authorization: Bearer {token}
x-restli-method: batch_update

Request Body:

{
  "entities": {
    "CAND_NOTE123": {
      "atsCreatedAt": 1484864187000,
      "note": "Lorem Ipsum.",
      "author": {
        "firstName": "Angela",
        "lastName": "Smith"
      }
    },
    "CAND_NOTE456": {
      "atsCreatedAt": 1484864187000,
      "note": "Lorem Ipsum moreum.",
      "author": {
        "firstName": "Bobby",
        "lastName": "Hill"
      }
    }
  }
}

Sample Response

A successful request will return a 200 OK response code, and you will find the status of each entity in the response body.

Sample Response Body

{
    "errors": {},
    "results": {
        "CAND_NOTE123": {
            "status": 204
        },
        "CAND_NOTE456": {
            "status": 204
        }
    }
}

Note

  • Be sure to check the response for error statuses corresponding to individual entities you submit.

Delete Candidate Notes

API Details

Perform HTTP DELETE on /atsCandidates/{CandidateIdentifier}/notes endpoint to delete candidate notes. More information is available here.