Skip to content

Deel: Add content to the private note of a job

Deel ats.addToJobPrivateNote: arguments, response, policy and SDK examples.

← ATS operations · Get started

Operation deel.ats_addtojobprivatenote_v2026_11_02

Provider route: POST /ats/jobs/{job_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["ats"]["addToJobPrivateNote"]>[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.ats.addToJobPrivateNote(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.add_to_job_private_note(arguments)
result = await call.wait()
return result.body_json()
FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
pathobjectRequired within parentAdditional keys: not allowed
path.job_idstringRequired within parentFormat: uuid
headersobjectRequired within parentAdditional keys: not allowed
headers.X-BetastringRequired within parentDefault: true
One of: true
bodyobjectOptional
body.dataModelRequired within parentExpand Add content to the private note of a job — request body — body data

Referenced models: Add content to the private note of a job — 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 content to the private note of a job — 201 response body

Referenced models: Add content to the private note of a job — 201 response body

Add content to the private note of a job — request body — body data
FieldTypePresenceDescription and constraints
$objectRoot
expected_updated_atstring or nullOptionalOptional precondition: the note's updated_at as last read, or null when the job had no note. If the note changed since, nothing is written and a 409 precondition_failed is returned.
Format: date-time
richtext_contentstringRequired within parentRich text HTML to add. It becomes the note when the job has none, otherwise it is appended after the existing content.
Minimum length: 1
Add content to the private note of a job — 201 response body
FieldTypePresenceDescription and constraints
$objectRoot
dataModelRequired within parentExpand Add content to the private note of a job — 201 response body — data
The job note after the write

Referenced models: Add content to the private note of a job — 201 response body — data

Add content to the private note of a job — 201 response body — data
FieldTypePresenceDescription and constraints
$objectRootThe job note after the write
created_atstringRequired within parentThe timestamp when the note was created
Format: date-time
created_by_hris_organization_user_idJSONRequired within parent
created_by_hris_organization_user_id (anyOf 1)stringAlternativeHRIS organization user ID of the user who created the note
Format: uuid
created_by_hris_organization_user_id (anyOf 2)nullAlternativeHRIS organization user ID of the user who created the note
Format: uuid
idstringRequired within parentThe unique identifier of the job note
Format: uuid
richtext_contentstringRequired within parentThe content of the note in rich text HTML format
updated_atstringRequired within parentThe timestamp when the note was last changed
Format: date-time
updated_by_hris_organization_user_idJSONRequired within parent
updated_by_hris_organization_user_id (anyOf 1)stringAlternativeHRIS organization user ID of the user who last changed the note
Format: uuid
updated_by_hris_organization_user_id (anyOf 2)nullAlternativeHRIS organization user ID of the user who last changed the note
Format: uuid

SDK function policy ID: deel.ats_addtojobprivatenote_v2026_11_02. Catalog operation: ats_addtojobprivatenote_v2026_11_02. 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", "worker:write"]

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

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.