Unified ATS API

Add note to application

Changed on

Add a note to an application.

Add extra information to an application. This can be any extra text information you want to add to an application.

<Note> This endpoint requires the permission **Add notes** to be enabled in [your scope config](/scopes). </Note>

Example Request Body

{
  "content": "A new message from the candidate is available in YourChat!",
  "content_type": "PLAIN_TEXT",
  "remote_fields": {}
}
post/ats/applications/{application_id}/notes

Request

Path parameters

application_idstring required

The Kombo ID of the application you want to create the note for.

Headers

X-Integration-Idstring required

ID of the integration you want to interact with.

Request body

titlestring

Title of the note, often called "subject" in the ATS. If the ATS has no note title, the title becomes the first line of the content instead.

contentstring required

UTF-8 content of the note.

content_type'PLAIN_TEXT' required

Content type of the note. Currently only PLAIN_TEXT is supported.

Response

POST /ats/applications/:application_id/notes Positive response

status'success' required
dataobject required

Example response

{
  "data": {}
}

Changes