# Create Jobs

> Source: https://truto.one/docs/api-reference/unified-ats-api/jobs/create/

`POST /unified/ats/jobs`

Resource: **Jobs** · API: **Unified ATS API**

## Supported integrations

Breezy, Teamtailor

## Query parameters

- **`integrated_account_id`** _(string, required)_
  The ID of the integrated account to use for the request.
- **`truto_response_format`** _(string)_
  The format of the response. - `unified` returns the response with unified mappings applied. - `raw` returns the unprocessed, raw response from the remote API. - `normalized` applies the unified mappings and returns the data in a normalized format. - `stream` returns the response as a stream, which is ideal for transmitting large datasets, files, or binary data. Using streaming mode helps to efficiently handle large payloads or real-time data flows without requiring the entire data to be buffered in memory. - `debug` returns the final unified result alongside raw remote fetch information. The response is an envelope containing `result` (identical to unified mode output) and `debug` (with `requestUrl`, `requestOptions`, `data`, `responseHeaders`, and for list operations: `nextCursor`, `isLooping`, `isEmptyResult`, `resultCount`). When the upstream body exceeds 1 MiB, `data` is replaced by `{ truto_truncated: true, truto_max_bytes, truto_excerpt }`. `debug` is `null` for static responses or when `truto_skip_api_call=true`. Defaults to `unified`.
  Allowed: `unified`, `raw`, `normalized`, `stream`, `debug`
- **`truto_ignore_remote_data`** _(boolean)_
  Excludes the `remote_data` attribute from the response.
- **`truto_enforce_write_schema`** _(boolean)_
  Validates the request body against this method's `request_body_schema` before the request is sent to the underlying integration. When a field marked `required` is missing, Truto responds `400` with the missing field names under `truto_error_insight.missing_required_body_fields` instead of forwarding the call. Only the fields documented in `request_body_schema` are checked. A body carrying a non-empty `remote_data` object is forwarded unchecked, because `remote_data` is merged into the provider request and may already carry the required values. A field the mapping always supplies through its default body is treated as present, and a field that is only conditionally required is reported under `truto_error_insight.conditionally_required_body_fields` rather than rejected. Some integrations declare fields `required` on `update` that the provider only requires on `create`; check `meta/{method}` for the resource before enabling this on update calls. If you sent an `Idempotency-Key` and the request was rejected, use a fresh key when you retry with a corrected body: the idempotency cache is keyed on the integrated account, path and key only — it ignores the query string and the body — so reusing the key replays the rejection. Defaults to `false`, which forwards the request as-is.
- **`truto_exclude_fields`** _(array<string>)_
  Array of fields to exclude from the response.
- **`remote_query`** _(object)_
  Query parameters to pass to the underlying API without any transformations. Refer [this guide](https://truto.one/docs/api-reference/overview/querying#remote-query-parameters) to see how to structure the query parameters.
- **`organization_id`** _(string)_
  Breezy company ID; the connected account company is used when omitted.
- **`location_country`** _(string)_
  ISO 3166-1 alpha-2 country code required by Breezy.
- **`location_state`** _(string)_
  State or province accepted by Breezy.
- **`location_city`** _(string)_
  City accepted by Breezy.

## Request body

- **`name`** _(string)_
  Job title.
- **`description`** _(string)_
  Job description; Teamtailor accepts simple HTML.
- **`requisition_id`** _(string)_
  The job's requisition_id
- **`departments`** _(array<object>)_
  The job's department
  - **`id`** _(string, required)_
    Unique identifier of the department
  - **`name`** _(string)_
    The department's name
- **`tags`** _(array<string>)_
  The job's tags
- **`is_remote`** _(boolean)_
  Whether the job is remote or not
- **`job_type`** _(string)_
  The job's type.
  Allowed: `full_time`, `part_time`, `contract`, `internship`, `temporary`, `volunteer`, `per_diem`, `full_time`, `part_time`, `contract`, `temporary`
- **`job_position_level`** _(string)_
  The job's position level.
- **`compensation`** _(object)_
  - **`id`** _(string)_
    The job's compensation unique identifier
  - **`currency`** _(string)_
    The job's compensation currency
  - **`min`** _(number)_
    The job's minimum compensation
  - **`max`** _(number)_
    The job's maximum compensation
  - **`interval`** _(string)_
    The job's compensation interval. If no clear mapping exists, then raw value is returned.
    Allowed: `yearly`, `monthly`, `weekly`, `daily`, `hourly`, `one_time`, `semi_monthly`, `bi_monthly`, `bi_weekly`, `hourly`, `daily`, `weekly` (+3 more)
  - **`is_negotiable`** _(boolean)_
    Whether the job's compensation is negotiable or not
  - **`notes`** _(string)_
    The job's compensation notes
- **`status`** _(string)_
  Mapped to Teamtailor open/archived/draft/unlisted states.
  Allowed: `open`, `closed`, `draft`, `pending`, `archived`, `open`, `draft`, `pending`, `archived`
- **`confidential`** _(boolean)_
  Whether the job is confidential or not
- **`offices`** _(array<object>)_
  The job's office
  - **`id`** _(string, required)_
    Unique identifier of the office
  - **`name`** _(string)_
    The office's name
- **`recruiters`** _(array<object>)_
  The job's recruiters
  - **`id`** _(string, required)_
    Unique identifier of the user
  - **`name`** _(string)_
    The user's name
- **`remote_data`** _(object)_
  Any additional data that should be passed as part of the request body. This data is not transformed by Truto and is passed as is to the remote API.

## Response body

- **`id`** _(string, required)_
  The job's unique identifier
- **`name`** _(string)_
  The job's name
- **`description`** _(string)_
  The job's description
- **`code`** _(string)_
  The job's code
- **`requisition_id`** _(string)_
  The job's requisition_id
- **`status`** _(string)_
  The job's status
  Allowed: `open`, `closed`, `draft`, `pending`, `archived`
- **`locations`** _(array<string>)_
  The job's locations
- **`job_posting_urls`** _(array<object>)_
  The job's job posting urls
  - **`url`** _(string)_
    The job posting URL
  - **`type`** _(string)_
    The job posting URL's type
- **`confidential`** _(boolean)_
  Whether the job is confidential or not
- **`departments`** _(array<object>)_
  The job's department
  - **`id`** _(string)_
    Unique identifier of the department
  - **`name`** _(string)_
    The department's name
- **`teams`** _(array<object>)_
- **`offices`** _(array<object>)_
  The job's office
  - **`id`** _(string)_
    Unique identifier of the office
  - **`name`** _(string)_
    The office's name
- **`hiring_managers`** _(array<object>)_
  The job's hiring managers
  - **`id`** _(string)_
    Unique identifier of the user
  - **`name`** _(string)_
    The user's name
- **`recruiters`** _(array<object>)_
  The job's recruiters
  - **`id`** _(string)_
    Unique identifier of the user
  - **`name`** _(string)_
    The user's name
- **`tags`** _(array<string>)_
  The job's tags
- **`is_remote`** _(boolean)_
  Whether the job is remote or not
- **`job_type`** _(string)_
  The job's type.
  Allowed: `full_time`, `part_time`, `contract`, `internship`, `temporary`, `volunteer`, `per_diem`
- **`job_position_level`** _(string)_
  The job's position level.
- **`compensation`** _(object)_
  - **`id`** _(string)_
    The job's compensation unique identifier
  - **`currency`** _(string)_
    The job's compensation currency
  - **`min`** _(number)_
    The job's minimum compensation
  - **`max`** _(number)_
    The job's maximum compensation
  - **`interval`** _(string)_
    The job's compensation interval. If no clear mapping exists, then raw value is returned.
    Allowed: `yearly`, `monthly`, `weekly`, `daily`, `hourly`, `one_time`, `semi_monthly`, `bi_monthly`, `bi_weekly`
  - **`is_negotiable`** _(boolean)_
    Whether the job's compensation is negotiable or not
  - **`notes`** _(string)_
    The job's compensation notes
- **`created_at`** _(string)_
  The date and time of the job's creation
- **`updated_at`** _(string)_
  The date and time of the job's last update
- **`closed_at`** _(string)_
  The date and time of the job's closing
- **`opened_at`** _(string)_
  The date and time of the job's opening
- **`remote_data`** _(object)_
  Raw data returned from the remote API call.

## Code examples

### Truto CLI

```bash
truto unified ats jobs \
  -m create \
  -a '<integrated_account_id>' \
  -b '{
  "name": "your_name",
  "description": "your_description",
  "requisition_id": "your_requisition_id",
  "departments": [],
  "tags": [],
  "is_remote": true,
  "job_type": "full_time",
  "job_position_level": "your_job_position_level",
  "compensation": {},
  "status": "open",
  "confidential": true,
  "offices": [],
  "recruiters": [],
  "remote_data": {}
}' \
  -o json
```

### Truto TS SDK

```typescript
import Truto from '@truto/truto-ts-sdk';

const truto = new Truto({
  token: '<your_api_token>',
});

const result = await truto.unifiedApi.create(
  'ats',
  'jobs',
  {
  "name": "your_name",
  "description": "your_description",
  "requisition_id": "your_requisition_id",
  "departments": [],
  "tags": [],
  "is_remote": true,
  "job_type": "full_time",
  "job_position_level": "your_job_position_level",
  "compensation": {},
  "status": "open",
  "confidential": true,
  "offices": [],
  "recruiters": [],
  "remote_data": {}
},
  { integrated_account_id: '<integrated_account_id>' }
);

console.log(result);
```

### Truto Python SDK

```python
import asyncio
from truto_python_sdk import TrutoApi

truto_api = TrutoApi(token="<your_api_token>")

async def main():
    result = await truto_api.unified_api.create(
        "ats",
        "jobs",
        {
        "name": "your_name",
        "description": "your_description",
        "requisition_id": "your_requisition_id",
        "departments": [],
        "tags": [],
        "is_remote": True,
        "job_type": "full_time",
        "job_position_level": "your_job_position_level",
        "compensation": {},
        "status": "open",
        "confidential": True,
        "offices": [],
        "recruiters": [],
        "remote_data": {}
},
        {"integrated_account_id": "<integrated_account_id>"}
    )
    print(result)

asyncio.run(main())
```

### curl

```bash
curl -X POST 'https://api.truto.one/unified/ats/jobs?integrated_account_id=<integrated_account_id>' \
  -H 'Authorization: Bearer <your_api_token>' \
  -H 'Content-Type: application/json' \
  -d '{
  "name": "your_name",
  "description": "your_description",
  "requisition_id": "your_requisition_id",
  "departments": [],
  "tags": [],
  "is_remote": true,
  "job_type": "full_time",
  "job_position_level": "your_job_position_level",
  "compensation": {},
  "status": "open",
  "confidential": true,
  "offices": [],
  "recruiters": [],
  "remote_data": {}
}'
```

### JavaScript

```javascript
const integratedAccountId = '<integrated_account_id>';

const body = {
  "name": "your_name",
  "description": "your_description",
  "requisition_id": "your_requisition_id",
  "departments": [],
  "tags": [],
  "is_remote": true,
  "job_type": "full_time",
  "job_position_level": "your_job_position_level",
  "compensation": {},
  "status": "open",
  "confidential": true,
  "offices": [],
  "recruiters": [],
  "remote_data": {}
};

const response = await fetch(`https://api.truto.one/unified/ats/jobs?integrated_account_id=${integratedAccountId}`, {
  method: 'POST',
  headers: {
    'Authorization': 'Bearer <your_api_token>',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify(body),
});

const data = await response.json();
console.log(data);
```

### Python

```python
import requests

url = "https://api.truto.one/unified/ats/jobs"
headers = {
    "Authorization": "Bearer <your_api_token>",
    "Content-Type": "application/json",
}
params = {
    "integrated_account_id": "<integrated_account_id>"
}
payload = {
    "name": "your_name",
    "description": "your_description",
    "requisition_id": "your_requisition_id",
    "departments": [],
    "tags": [],
    "is_remote": True,
    "job_type": "full_time",
    "job_position_level": "your_job_position_level",
    "compensation": {},
    "status": "open",
    "confidential": True,
    "offices": [],
    "recruiters": [],
    "remote_data": {}
}

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