Skip to content

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.

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 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_jobs.create_ats_job(arguments)
result = await call.wait()
return result.body_json()
FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
bodyobjectOptional
body.dataModelRequired within parentExpand Create ATS Job — request body — body data

Referenced models: Create ATS 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 Create ATS Job — 201 response body

Referenced models: Create ATS Job — 201 response body

1 more schema is linked from the tables above, on the schema pages.

Create ATS Job — request body — body data
FieldTypePresenceDescription and constraints
$objectRoot
department_idsarrayOptionalArray of department IDs (optional)
department_ids[]stringEach itemFormat: uuid
employment_type_idsarrayRequired within parentArray of employment type IDs (at least one required)
employment_type_ids[]stringEach itemFormat: uuid
interview_plan_idstringRequired within parentInterview Plan ID must be a valid UUID
Format: uuid
is_confidentialbooleanOptionalWhether the job posting is confidential
Default: false
location_idsarrayRequired within parentArray of location IDs (at least one required)
location_ids[]stringEach itemFormat: uuid
richtext_descriptionstring or nullOptionalRich text description of the job
Maximum length: 20000
statusstringOptionalInitial 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_idsarrayRequired within parentArray of team IDs (at least one required)
team_ids[]stringEach itemFormat: uuid
titlestringRequired within parentThe job title
Maximum length: 100
Minimum length: 1
work_arrangement_enumJSONOptionalWork arrangement of the job. Omit or send null to leave it unspecified.
work_arrangement_enum (oneOf 1)stringAlternativeWork arrangement of the job. Omit or send null to leave it unspecified.
One of: ON_SITE, HYBRID, REMOTE
work_arrangement_enum (oneOf 2)nullAlternative
Create ATS Job — 201 response body
FieldTypePresenceDescription and constraints
$objectRoot
dataModelRequired within parentExpand Create ATS Job — 201 response body — data

Referenced models: Create ATS Job — 201 response body — data

Create ATS Job — 201 response body — data
FieldTypePresenceDescription and constraints
$objectRoot
approval_request_idJSONRequired within parent
approval_request_id (anyOf 1)stringAlternativeID of the approval request for this job
Format: uuid
approval_request_id (anyOf 2)nullAlternativeID of the approval request for this job
Format: uuid
approval_rule_idJSONRequired within parent
approval_rule_id (anyOf 1)stringAlternativeID of the approval rule applied to this job
Format: uuid
approval_rule_id (anyOf 2)nullAlternativeID of the approval rule applied to this job
Format: uuid
created_atstringOptionalTimestamp when the job was created
Format: date-time
created_by_hris_organization_user_idJSONRequired within parent
created_by_hris_organization_user_id (anyOf 1)stringAlternativeID of the user who created the job
Format: uuid
created_by_hris_organization_user_id (anyOf 2)nullAlternativeID of the user who created the job
Format: uuid
idstringRequired within parentUnique identifier for the created job
Format: uuid
is_confidentialbooleanRequired within parentWhether the job posting is confidential
job_departmentsJSONOptional
job_departments (anyOf 1)arrayAlternativeDepartments associated with the job
job_departments (anyOf 1)[]ModelEach itemExpand Create ATS Job — 201 response body — data job departments Departments associated with the job item
job_departments (anyOf 2)nullAlternativeDepartments associated with the job
job_departments (anyOf 2)[]ModelEach itemExpand Create ATS Job — 201 response body — data job departments Departments associated with the job item
job_employment_typesarrayRequired within parentEmployment types associated with the job
job_employment_types[]ModelEach itemExpand Create ATS Job — 201 response body — data job employment types item
job_locationsarrayRequired within parentLocations associated with the job
job_locations[]ModelEach itemExpand Create ATS Job — 201 response body — data job locations item
job_teamsarrayRequired within parentTeams associated with the job
job_teams[]ModelEach itemExpand Create ATS Job — 201 response body — data job teams item
richtext_descriptionJSONOptional
richtext_description (anyOf 1)stringAlternativeRich text description of the job
richtext_description (anyOf 2)nullAlternativeRich text description of the job
statusstringRequired within parentCurrent status of the job
Known values: DRAFT, WAITING_FOR_APPROVAL, APPROVED, NOT_APPROVED, OPEN, CLOSED, ARCHIVED
titlestringRequired within parentThe job title
updated_atstringOptionalTimestamp when the job was last updated
Format: date-time
work_arrangement_enumJSONOptionalWork arrangement of the job. Null when unspecified.
work_arrangement_enum (anyOf 1)stringAlternativeWork arrangement of the job. Null when unspecified.
Known values: ON_SITE, HYBRID, REMOTE
work_arrangement_enum (anyOf 2)nullAlternative

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
FieldTypePresenceDescription and constraints
$objectRoot
employment_typeModelRequired within parentExpand Create ATS Job — 201 response body — data job employment types item employment type
idstringRequired within parentUnique 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
FieldTypePresenceDescription and constraints
$objectRoot
idstringRequired within parentUnique identifier for the job location
Format: uuid
locationModelRequired within parentExpand 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
FieldTypePresenceDescription and constraints
$objectRoot
idstringRequired within parentUnique identifier for the job team
Format: uuid
teamModelRequired within parentExpand 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
FieldTypePresenceDescription and constraints
$objectRoot
departmentJSONRequired within parent
department (anyOf 1)ModelAlternativeExpand Create ATS Job — 201 response body — data job departments Departments associated with the job item department id, name
department (anyOf 2)nullAlternative
idstringRequired within parentUnique 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
FieldTypePresenceDescription and constraints
$objectRoot
idstringRequired within parentUnique identifier for the employment type
Format: uuid
namestringRequired within parentEmployment type name
Create ATS Job — 201 response body — data job locations item location
FieldTypePresenceDescription and constraints
$objectRoot
idstringRequired within parentUnique identifier for the location
Format: uuid
namestringRequired within parentLocation name
Create ATS Job — 201 response body — data job teams item team
FieldTypePresenceDescription and constraints
$objectRoot
idstringRequired within parentUnique identifier for the team
Format: uuid
namestringRequired within parentTeam name

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"}

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.