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.
Call through Alter
Section titled “Call through Alter”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 osfrom alter_sdk import Appfrom 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()| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
path | object | Required within parent | Additional keys: not allowed |
path.job_id | string | Required within parent | Format: uuid |
headers | object | Required within parent | Additional keys: not allowed |
headers.X-Beta | string | Required within parent | Default: true One of: true |
body | object | Optional | |
body.data | Model | Required within parent | Expand 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
Section titled “Response”Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | Model | Root | Expand 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
Schemas
Section titled “Schemas”Add content to the private note of a job — request body — body data
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
expected_updated_at | string or null | Optional | Optional 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_content | string | Required within parent | Rich 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | Model | Required within parent | Expand 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | The job note after the write |
created_at | string | Required within parent | The timestamp when the note was created Format: date-time |
created_by_hris_organization_user_id | JSON | Required within parent | |
created_by_hris_organization_user_id (anyOf 1) | string | Alternative | HRIS organization user ID of the user who created the note Format: uuid |
created_by_hris_organization_user_id (anyOf 2) | null | Alternative | HRIS organization user ID of the user who created the note Format: uuid |
id | string | Required within parent | The unique identifier of the job note Format: uuid |
richtext_content | string | Required within parent | The content of the note in rich text HTML format |
updated_at | string | Required within parent | The timestamp when the note was last changed Format: date-time |
updated_by_hris_organization_user_id | JSON | Required within parent | |
updated_by_hris_organization_user_id (anyOf 1) | string | Alternative | HRIS organization user ID of the user who last changed the note Format: uuid |
updated_by_hris_organization_user_id (anyOf 2) | null | Alternative | HRIS organization user ID of the user who last changed the note Format: uuid |
Policy, approvals and errors
Section titled “Policy, approvals and errors”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"}