Skip to main content
POST
/
ats
/
applications
/
{application_id}
/
notes
TypeScript
import { Kombo } from "@kombo-api/sdk";

const kombo = new Kombo({
  integration_id: "workday:HWUTwvyx2wLoSUHphiWVrp28",
  api_key: "<YOUR_BEARER_TOKEN_HERE>",
});

async function run() {
  const result = await kombo.ats.addApplicationNote({
    application_id: "8Xi6iZrwusZqJmDGXs49GBmJ",
    body: {
      content: "A new message from the candidate is available in YourChat!",
      content_type: "PLAIN_TEXT",
    },
  });

  console.log(result);
}

run();
{
  "status": "success",
  "data": {},
  "warnings": [
    {
      "message": "This is an example warning!"
    }
  ]
}

Documentation Index

Fetch the complete documentation index at: https://docs.kombo.dev/llms.txt

Use this file to discover all available pages before exploring further.

Add extra information to an application. This can be any extra text information you want to add to an application.
This endpoint requires the permission Add notes to be enabled in your scope config.

​
Example Request Body

{
  "content": "A new message from the candidate is available in YourChat!",
  "content_type": "PLAIN_TEXT",
  "remote_fields": {}
}

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.

Response

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

​
status
string
required
Allowed value: "success"
​
data
object
required
Example:
{}
​
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.