Skip to main content
POST
/
ats
/
applications
/
{application_id}
/
notes
Python
from kombo import SDK


with SDK(
    integration_id="workday:HWUTwvyx2wLoSUHphiWVrp28",
    api_key="<YOUR_BEARER_TOKEN_HERE>",
) as sdk:

    res = sdk.ats.add_application_note(application_id="8Xi6iZrwusZqJmDGXs49GBmJ", content="A new message from the candidate is available in YourChat!", content_type="PLAIN_TEXT")

    # Handle response
    print(res)
{
  "status": "success",
  "data": {},
  "warnings": [
    {
      "message": "This is an example warning!"
    }
  ]
}

Authorizations

​
Authorization
string
header
required

Create an API key on the Secrets page in the Kombo dashboard.

Headers

​
X-Integration-Id
string
required

ID of the integration you want to interact with.

Path Parameters

​
application_id
string
required

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

Body

application/json

POST /ats/applications/:application_id/notes Request body

​
content
string
required

UTF-8 content of the note.

​
content_type
enum<string>
required

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

Available options:
PLAIN_TEXT
​
remote_fields
object

Tool specific remote fields for the note. Additional fields that we will pass through to specific ATS systems.

Response

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

​
status
string
required
Allowed value: "success"
​
data
object
required
Examples:
{}
​
warnings
object[]
required

These are the interaction warnings that are shown in the dashboard. They are meant to provide debug information to you. We recommend logging them to the console.