v1

latestOpenAPI 3.1.02026-07-1276185442.2 KB

Interviews

Notes

Update Interview Note

patch/unified/ats/interviews/{id}/notes/{subResourceId}

Path parameters

idstring required

subResourceIdstring required

Headers

x-account-idstring required

The account identifier

Preferstring

Example:heartbeat

Set to "heartbeat" to enable keep-alive newline heartbeats during long-running requests. Response includes Preference-Applied: heartbeat header when honored. (RFC 7240)

Request body

author_idstring nullable

Unique identifier of the author

passthroughobject nullable

Value to pass through to the provider

Example request

{
  "content": [
    {
      "body": "This candidate seems like a good fit for the role"
    }
  ],
  "author_id": "1234567890",
  "visibility": {
    "value": "public"
  },
  "passthrough": {
    "other_known_names": "John Doe"
  }
}

Response

Record updated successfully.

statusCodenumber required

messagestring required

timestampstring date-time required

Example response

{
  "statusCode": 200,
  "message": "Record updated successfully.",
  "timestamp": "2021-01-01T01:01:01.000Z"
}