> This page is for API, version 2026-01-01 (Stable) (default).
> For other versions, use one of these documentation indexes:
> - 2026-01-01 (Stable) (default): https://docs.deel.wtf/api/stable/llms.txt

> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://docs.deel.wtf/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.deel.wtf/_mcp/server.

# Add content to the private note of a job

POST https://api.letsdeel.com/rest/ats/jobs/{job_id}/notes
Content-Type: application/json

Adds context to the job's private note, which the hiring team shares. A job has a single note: the first call creates it and later calls append to it, so earlier content is never overwritten.

 **Token scopes**: `ats:write`, `worker:write`

 **Beta**: this version requires the `X-Beta: true` request header and its contract may change before it is promoted to stable. It is scheduled to become stable on 2027-01-29.

Reference: https://docs.deel.wtf/api/reference/endpoints/ats/add-to-job-private-note-v-2026-10-29

## Authentication

- `Authorization` header (bearer token, required) — ## Authentication The Deel API uses bearer tokens to authenticate requests. All API calls must be made over HTTPS — calls over plain HTTP or without authentication will fail. ```curl curl -X GET 'https://api.deel.training/rest/v2/contracts' \ -H 'Authorization: Bearer YOUR-TOKEN-HERE' ``` [Learn more about authentication](/api/authentication)
- `Authorization` header (bearer token, required) — Standard OAuth2 security scheme based on https://swagger.io/docs/specification/authentication/

## Servers

- `https://api.letsdeel.com/rest` (Production, default)
- `https://api-staging.letsdeel.com/rest` (Demo)

## Request

### Path parameters

- `job_id` (string, required) — ID of the job whose note is written

### Headers

- `X-Beta` (enum, required, default: true) — Opts in to the beta version of this endpoint. Must be `true`.
  - Allowed values: `true`

### Body (application/json)

This endpoint expects an object.

- `data` (AtsJobsJobIdNotesPostRequestBodyContentApplicationJsonSchemaData, required)

## Response

### 201

The job note after the content was added

- `data` (AtsJobsJobIdNotesPostResponsesContentApplicationJsonSchemaData, required) — The job note after the write

## Errors

### 400 Bad Request Error

Operation failed.

- `errors` (list of AtsJobsJobIdNotesPostResponsesContentApplicationJsonSchemaErrorsItems, required) — List of error objects

### 401 Unauthorized Error

Operation failed.

- `request` (ApiErrorRequest, optional)
- `errors` (list of ApiError, optional)

### 403 Forbidden Error

Forbidden. ATS is not enabled for this organization or insufficient permissions.

- `errors` (list of AtsJobsJobIdNotesPostResponsesContentApplicationJsonSchemaErrorsItems, required) — List of error objects

### 404 Not Found Error

Not found, or not visible to the authenticated user. The two cases are indistinguishable.

- `errors` (list of AtsJobsJobIdNotesPostResponsesContentApplicationJsonSchemaErrorsItems, required) — List of error objects

### 409 Conflict Error

Conflict (`precondition_failed`). An `expected_*` value no longer matches the record (`field` names it): re-read the record and confirm again, never retry blindly.

- `errors` (list of AtsJobsJobIdNotesPostResponsesContentApplicationJsonSchemaErrorsItems, required) — List of error objects

### 500 Internal Server Error

Operation failed.

- `errors` (list of AtsJobsJobIdNotesPostResponsesContentApplicationJsonSchemaErrorsItems, required) — List of error objects

## Types

### AtsJobsJobIdNotesPostRequestBodyContentApplicationJsonSchemaData

- `richtext_content` (string, required) — Rich text HTML to add. It becomes the note when the job has none, otherwise it is appended after the existing content.
- `expected_updated_at` (string, optional, nullable) — 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.

### AtsJobsJobIdNotesPostResponsesContentApplicationJsonSchemaData

The job note after the write

- `id` (string, required) — The unique identifier of the job note
- `created_at` (string, required) — The timestamp when the note was created
- `updated_at` (string, required) — The timestamp when the note was last changed
- `richtext_content` (string, required) — The content of the note in rich text HTML format
- `created_by_hris_organization_user_id` (string, required, nullable) — HRIS organization user ID of the user who created the note
- `updated_by_hris_organization_user_id` (string, required, nullable) — HRIS organization user ID of the user who last changed the note

### AtsJobsJobIdNotesPostResponsesContentApplicationJsonSchemaErrorsItems

- `code` (string, required) — Machine-readable error code
- `message` (string, required) — Human-readable error message
- `field` (string, optional) — Request field related to the error, if applicable

### ApiErrorRequest

- `method` (string, optional) — The HTTP method of the failed request
- `url` (string, optional) — The relative URL of the failed request
- `status` (double, optional) — The status code of the response
- `api_req_id` (string, optional) — The request ID of the failed request
- `docs` (string, optional) — A link to the official documentation for the requested endpoint resource
- `source` (string, optional) — The source handler which produced the returned error
- `code` (double, optional) — The code of the source handler which produced the returned error

### ApiError

- `message` (string, optional) — A description of the returned error
- `path` (string, optional) — The JSON path where input validation failed

## Examples

**Request**

```json
{
  "data": {
    "richtext_content": "<p>Hiring manager prefers candidates who can start before March.</p>"
  }
}
```

**Response**

```json
{
  "data": {
    "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "created_at": "2026-10-23T10:30:00.000Z",
    "updated_at": "2026-10-23T10:30:00.000Z",
    "richtext_content": "<p>Hiring manager prefers candidates who can start before March.</p>",
    "created_by_hris_organization_user_id": "123e4567-e89b-12d3-a456-426614174000",
    "updated_by_hris_organization_user_id": "123e4567-e89b-12d3-a456-426614174000"
  }
}
```

**SDK Code**

```python
import requests

url = "https://api.letsdeel.com/rest/ats/jobs/faac641e-a484-4875-aed5-bfcb0a0691a0/notes"

payload = { "data": { "richtext_content": "<p>Hiring manager prefers candidates who can start before March.</p>" } }
headers = {
    "X-Beta": "true",
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.json())
```

```javascript
const url = 'https://api.letsdeel.com/rest/ats/jobs/faac641e-a484-4875-aed5-bfcb0a0691a0/notes';
const options = {
  method: 'POST',
  headers: {
    'X-Beta': 'true',
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/json'
  },
  body: '{"data":{"richtext_content":"<p>Hiring manager prefers candidates who can start before March.</p>"}}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go
package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.letsdeel.com/rest/ats/jobs/faac641e-a484-4875-aed5-bfcb0a0691a0/notes"

	payload := strings.NewReader("{\n  \"data\": {\n    \"richtext_content\": \"<p>Hiring manager prefers candidates who can start before March.</p>\"\n  }\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("X-Beta", "true")
	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby
require 'uri'
require 'net/http'

url = URI("https://api.letsdeel.com/rest/ats/jobs/faac641e-a484-4875-aed5-bfcb0a0691a0/notes")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["X-Beta"] = 'true'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"data\": {\n    \"richtext_content\": \"<p>Hiring manager prefers candidates who can start before March.</p>\"\n  }\n}"

response = http.request(request)
puts response.read_body
```

```java
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.post("https://api.letsdeel.com/rest/ats/jobs/faac641e-a484-4875-aed5-bfcb0a0691a0/notes")
  .header("X-Beta", "true")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"data\": {\n    \"richtext_content\": \"<p>Hiring manager prefers candidates who can start before March.</p>\"\n  }\n}")
  .asString();
```

```php
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'https://api.letsdeel.com/rest/ats/jobs/faac641e-a484-4875-aed5-bfcb0a0691a0/notes', [
  'body' => '{
  "data": {
    "richtext_content": "<p>Hiring manager prefers candidates who can start before March.</p>"
  }
}',
  'headers' => [
    'Authorization' => 'Bearer <token>',
    'Content-Type' => 'application/json',
    'X-Beta' => 'true',
  ],
]);

echo $response->getBody();
```

```csharp
using RestSharp;

var client = new RestClient("https://api.letsdeel.com/rest/ats/jobs/faac641e-a484-4875-aed5-bfcb0a0691a0/notes");
var request = new RestRequest(Method.POST);
request.AddHeader("X-Beta", "true");
request.AddHeader("Authorization", "Bearer <token>");
request.AddHeader("Content-Type", "application/json");
request.AddParameter("application/json", "{\n  \"data\": {\n    \"richtext_content\": \"<p>Hiring manager prefers candidates who can start before March.</p>\"\n  }\n}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let headers = [
  "X-Beta": "true",
  "Authorization": "Bearer <token>",
  "Content-Type": "application/json"
]
let parameters = ["data": ["richtext_content": "<p>Hiring manager prefers candidates who can start before March.</p>"]] as [String : Any]

let postData = JSONSerialization.data(withJSONObject: parameters, options: [])

let request = NSMutableURLRequest(url: NSURL(string: "https://api.letsdeel.com/rest/ats/jobs/faac641e-a484-4875-aed5-bfcb0a0691a0/notes")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "POST"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```