Share via

Sync Application Notes

  • Article

Application notes should be sent via the Middleware Platform whenever they are created or updated in your ATS. Use both your application identifier and note identifier when syncing application 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 Application Notes

Use the following endpoint to create and update application notes:

PUT https://api.linkedin.com/v2/atsApplications/atsJobApplicationId={id1}&dataProvider=ATS&integrationContext={organization URN}/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 person who wrote the note Actor No
note A note about the application 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": {
    "APPL_NOTE123": {
      "atsCreatedAt": 1484864187000,
      "note": "Lorem Ipsum.",
      "author": {
        "firstName": "Angela",
        "lastName": "Smith"
      }
    },
    "APPL_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": {
        "APPL_NOTE123": {
            "status": 204
        },
        "APPL_NOTE456": {
            "status": 204
        }
    }
}

Note

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

Delete Application Notes

API Details

Perform HTTP DELETE on the endpoint /atsApplications/{JobApplicationIdentifier}/notes to delete application notes. More information is available here.