Skip to content

Deel: Add note to an application — ats Applications add Note To An Application V20261106

Deel atsApplications.addNoteToAnApplicationV20261106: arguments, response, policy and SDK examples.

← ATS applications operations · Get started

Operation deel.atsapplications_addnotetoanapplication_v2026_11_06

Provider route: POST /ats/applications/{application_id}/notes. Alter supplies the connection’s credentials and routing.

Install @alter-ai/sdk @alter-ai/deel with npm, or alter-sdk-deel with pip. Supply your connected customer’s grant ID and the arguments described below.

import { App } from "@alter-ai/sdk";
import { DeelIntegration } from "@alter-ai/deel";
async function execute(input: Parameters<DeelIntegration["atsApplications"]["addNoteToAnApplicationV20261106"]>[0]) {
const app = new App({ apiKey: process.env.ALTER_API_KEY! });
try {
const provider = new DeelIntegration(app, { grantId: process.env.PROVIDER_GRANT_ID! });
const call = await provider.atsApplications.addNoteToAnApplicationV20261106(input);
const result = await call.wait();
return result.bodyJson();
} finally {
await app.close();
}
}
import os
from alter_sdk import App
from alter_sdk_deel import DeelIntegration
async def execute(arguments):
async with App(api_key=os.environ["ALTER_API_KEY"]) as app:
provider = DeelIntegration(app, {"grant_id": os.environ["PROVIDER_GRANT_ID"]})
call = await provider.ats_applications.add_note_to_an_application_v2026_11_06(arguments)
result = await call.wait()
return result.body_json()
FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
pathobjectRequired within parentAdditional keys: not allowed
path.application_idstringRequired within parentFormat: uuid
bodyobjectOptional
body.dataModelRequired within parentExpand Add note to an application — ats Applications add Note To An Application V20261106 — request body — body data

Referenced models: Add note to an application — ats Applications add Note To An Application V20261106 — request body — body data

Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.

FieldTypePresenceDescription and constraints
$ModelRootExpand Add note to an application — ats Applications add Note To An Application — 201 response body

Referenced models: Add note to an application — ats Applications add Note To An Application — 201 response body

Add note to an application — ats Applications add Note To An Application V20261106 — request body — body data
FieldTypePresenceDescription and constraints
$objectRoot
richtext_contentstringRequired within parentThe content of the note in rich text HTML format
Add note to an application — ats Applications add Note To An Application — 201 response body
FieldTypePresenceDescription and constraints
$objectRoot
dataModelRequired within parentExpand Add note to an application — ats Applications add Note To An Application — 201 response body — data
The created application note

Referenced models: Add note to an application — ats Applications add Note To An Application — 201 response body — data

Add note to an application — ats Applications add Note To An Application — 201 response body — data
FieldTypePresenceDescription and constraints
$objectRootThe created application note
created_atstringRequired within parentThe timestamp when the application note was created
Format: date-time
idstringRequired within parentThe unique identifier of the application note
Format: uuid
updated_atstringRequired within parentThe timestamp when the application note was last updated
Format: date-time

SDK function policy ID: deel.atsapplications_addnotetoanapplication_v2026_11_06. Catalog operation: atsapplications_addnotetoanapplication_v2026_01_01. Rules can name either ID; function rules distinguish managed calls and conservatively cover raw calls sharing the route. Existing grant permissions and policy rules apply. wait() returns an immediate result or waits for a required approval; it never approves the request itself. Persist the approval ID to resume after a restart.

Provider errors retain their response; JSON decoding raises ProviderAPIError for provider failures. ManagedOperationError identifies contract/input/retention errors. See error handling and provider-specific behavior. Sensitive input may be refused before approval storage. A decoding error never resubmits a write.

Required provider scopes: ["ats:write"]

Pinned headers: {"X-Version": "2026-11-06"}

Official provider source

Report an issue with this page

Necessary

Required for sign-in, security, authorization, and remembering your choices.

Always active

Analytics

Helps us understand which product and documentation features are useful.

Performance diagnostics

Uses performance tracing and privacy-masked session replay to diagnose problems.

You can change these choices at any time from Cookie settings.