Deel: Create ATS Job
Deel atsJobs.createAtsJob: arguments, response, policy and SDK examples.
← ATS jobs operations · Get started
Operation deel.atsjobs_createatsjob
Provider route: POST /ats/jobs. 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["atsJobs"]["createAtsJob"]>[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.atsJobs.createAtsJob(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_jobs.create_ats_job(arguments) result = await call.wait() return result.body_json()| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
body | object | Optional | |
body.data | Model | Required within parent | Expand Create ATS Job — request body — body data |
Referenced models: Create ATS 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 Create ATS Job — 201 response body |
Referenced models: Create ATS Job — 201 response body
Schemas
Section titled “Schemas”1 more schema is linked from the tables above, on the schema pages.
Create ATS Job — request body — body data
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
department_ids | array | Optional | Array of department IDs (optional) |
department_ids[] | string | Each item | Format: uuid |
employment_type_ids | array | Required within parent | Array of employment type IDs (at least one required) |
employment_type_ids[] | string | Each item | Format: uuid |
interview_plan_id | string | Required within parent | Interview Plan ID must be a valid UUID Format: uuid |
is_confidential | boolean | Optional | Whether the job posting is confidential Default: false |
location_ids | array | Required within parent | Array of location IDs (at least one required) |
location_ids[] | string | Each item | Format: uuid |
richtext_description | string or null | Optional | Rich text description of the job Maximum length: 20000 |
status | string | Optional | Initial status of the job. Defaults to the status derived from the applicable approval rule when omitted. One of: DRAFT, WAITING_FOR_APPROVAL, APPROVED, NOT_APPROVED, OPEN, CLOSED, ARCHIVED |
team_ids | array | Required within parent | Array of team IDs (at least one required) |
team_ids[] | string | Each item | Format: uuid |
title | string | Required within parent | The job title Maximum length: 100 Minimum length: 1 |
work_arrangement_enum | JSON | Optional | Work arrangement of the job. Omit or send null to leave it unspecified. |
work_arrangement_enum (oneOf 1) | string | Alternative | Work arrangement of the job. Omit or send null to leave it unspecified. One of: ON_SITE, HYBRID, REMOTE |
work_arrangement_enum (oneOf 2) | null | Alternative |
Create ATS Job — 201 response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | Model | Required within parent | Expand Create ATS Job — 201 response body — data |
Referenced models: Create ATS Job — 201 response body — data
Create ATS Job — 201 response body — data
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
approval_request_id | JSON | Required within parent | |
approval_request_id (anyOf 1) | string | Alternative | ID of the approval request for this job Format: uuid |
approval_request_id (anyOf 2) | null | Alternative | ID of the approval request for this job Format: uuid |
approval_rule_id | JSON | Required within parent | |
approval_rule_id (anyOf 1) | string | Alternative | ID of the approval rule applied to this job Format: uuid |
approval_rule_id (anyOf 2) | null | Alternative | ID of the approval rule applied to this job Format: uuid |
created_at | string | Optional | Timestamp when the job 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 | ID of the user who created the job Format: uuid |
created_by_hris_organization_user_id (anyOf 2) | null | Alternative | ID of the user who created the job Format: uuid |
id | string | Required within parent | Unique identifier for the created job Format: uuid |
is_confidential | boolean | Required within parent | Whether the job posting is confidential |
job_departments | JSON | Optional | |
job_departments (anyOf 1) | array | Alternative | Departments associated with the job |
job_departments (anyOf 1)[] | Model | Each item | Expand Create ATS Job — 201 response body — data job departments Departments associated with the job item |
job_departments (anyOf 2) | null | Alternative | Departments associated with the job |
job_departments (anyOf 2)[] | Model | Each item | Expand Create ATS Job — 201 response body — data job departments Departments associated with the job item |
job_employment_types | array | Required within parent | Employment types associated with the job |
job_employment_types[] | Model | Each item | Expand Create ATS Job — 201 response body — data job employment types item |
job_locations | array | Required within parent | Locations associated with the job |
job_locations[] | Model | Each item | Expand Create ATS Job — 201 response body — data job locations item |
job_teams | array | Required within parent | Teams associated with the job |
job_teams[] | Model | Each item | Expand Create ATS Job — 201 response body — data job teams item |
richtext_description | JSON | Optional | |
richtext_description (anyOf 1) | string | Alternative | Rich text description of the job |
richtext_description (anyOf 2) | null | Alternative | Rich text description of the job |
status | string | Required within parent | Current status of the job Known values: DRAFT, WAITING_FOR_APPROVAL, APPROVED, NOT_APPROVED, OPEN, CLOSED, ARCHIVED |
title | string | Required within parent | The job title |
updated_at | string | Optional | Timestamp when the job was last updated Format: date-time |
work_arrangement_enum | JSON | Optional | Work arrangement of the job. Null when unspecified. |
work_arrangement_enum (anyOf 1) | string | Alternative | Work arrangement of the job. Null when unspecified. Known values: ON_SITE, HYBRID, REMOTE |
work_arrangement_enum (anyOf 2) | null | Alternative |
Referenced models: Create ATS Job — 201 response body — data job employment types item, Create ATS Job — 201 response body — data job locations item, Create ATS Job — 201 response body — data job teams item, Create ATS Job — 201 response body — data job departments Departments associated with the job item
Create ATS Job — 201 response body — data job employment types item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
employment_type | Model | Required within parent | Expand Create ATS Job — 201 response body — data job employment types item employment type |
id | string | Required within parent | Unique identifier for the job employment type Format: uuid |
Referenced models: Create ATS Job — 201 response body — data job employment types item employment type
Create ATS Job — 201 response body — data job locations item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
id | string | Required within parent | Unique identifier for the job location Format: uuid |
location | Model | Required within parent | Expand Create ATS Job — 201 response body — data job locations item location |
Referenced models: Create ATS Job — 201 response body — data job locations item location
Create ATS Job — 201 response body — data job teams item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
id | string | Required within parent | Unique identifier for the job team Format: uuid |
team | Model | Required within parent | Expand Create ATS Job — 201 response body — data job teams item team |
Referenced models: Create ATS Job — 201 response body — data job teams item team
Create ATS Job — 201 response body — data job departments Departments associated with the job item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
department | JSON | Required within parent | |
department (anyOf 1) | Model | Alternative | Expand Create ATS Job — 201 response body — data job departments Departments associated with the job item department id, name |
department (anyOf 2) | null | Alternative | |
id | string | Required within parent | Unique identifier for the job department Format: uuid |
Referenced models: Create ATS Job — 201 response body — data job departments Departments associated with the job item department id, name
Create ATS Job — 201 response body — data job employment types item employment type
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
id | string | Required within parent | Unique identifier for the employment type Format: uuid |
name | string | Required within parent | Employment type name |
Create ATS Job — 201 response body — data job locations item location
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
id | string | Required within parent | Unique identifier for the location Format: uuid |
name | string | Required within parent | Location name |
Create ATS Job — 201 response body — data job teams item team
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
id | string | Required within parent | Unique identifier for the team Format: uuid |
name | string | Required within parent | Team name |
Policy, approvals and errors
Section titled “Policy, approvals and errors”SDK function policy ID: deel.atsjobs_createatsjob. Catalog operation: atsjobs_createatsjob. 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-01-01"}