Deel: Create ATS Application
Deel atsApplications.createAtsApplication: arguments, response, policy and SDK examples.
← ATS applications operations · Get started
Operation deel.atsapplications_createatsapplication_v2026_01_01
Provider route: POST /ats/applications. 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["atsApplications"]["createAtsApplication"]>[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.atsApplications.createAtsApplication(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_applications.create_ats_application(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 Application — request body — body data |
Referenced models: Create ATS Application — 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 Application — 201 response body |
Referenced models: Create ATS Application — 201 response body
Schemas
Section titled “Schemas”10 more schemas are linked from the tables above, on the schema pages.
Create ATS Application — request body — body data
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
application_form_submission_data | array or null | Optional | Array of form submission answers |
application_form_submission_data[] | Model | Each item | Expand Create ATS Application — request body — body data application form submission data item |
candidate_id | string | Required within parent | The ID of the candidate applying Format: uuid |
job_employment_type_id | string | Required within parent | The ID of the employment type for this job Format: uuid |
job_id | string | Required within parent | The ID of the job for this application Format: uuid |
job_posting_id | string or null | Optional | The ID of the job posting (optional) Format: uuid |
notes | array or null | Optional | Array of notes to attach to the application |
notes[] | Model | Each item | Expand Create ATS Application — request body — body data notes item |
source_slug | string | Optional | The application source. Accepts any active source slug of the organization, e.g. SOURCED_INTERNALLY, SOURCED_EXTERNALLY, INTERNAL_REFERRAL_AWARE, INTERNAL_REFERRAL_NOT_AWARE, EXTERNAL_CAREER_PAGE or a custom source slug (case-insensitive). Defaults to the candidate origin source when omitted. |
Referenced models: Create ATS Application — request body — body data application form submission data item, Create ATS Application — request body — body data notes item
Create ATS Application — 201 response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Created application response |
data | Model | Required within parent | Expand Create ATS Application — 201 response body — data |
Referenced models: Create ATS Application — 201 response body — data
Create ATS Application — request body — body data application form submission data item
Referenced models: Create ATS Application — request body — body / data / application_form_submission_data / item / type: FREETEXT, Create ATS Application — request body — body / data / application_form_submission_data / item / type: PARAGRAPH, Create ATS Application — request body — body / data / application_form_submission_data / item / type: PHONENUMBER, Create ATS Application — request body — body / data / application_form_submission_data / item / type: EMAIL, Create ATS Application — request body — body / data / application_form_submission_data / item / type: SINGLESELECTION, Create ATS Application — request body — body / data / application_form_submission_data / item / type: MULTISELECTION, Create ATS Application — request body — body / data / application_form_submission_data / item / type: DOCUMENTUPLOAD, Create ATS Application — request body — body / data / application_form_submission_data / item / type: PRESETDROPDOWN, Create ATS Application — request body — body / data / application_form_submission_data / item / type: CUSTOMDROPDOWN, Create ATS Application — request body — body / data / application_form_submission_data / item / type: NUMBER, Create ATS Application — request body — body / data / application_form_submission_data / item / type: DATEPICKER, Create ATS Application — request body — body / data / application_form_submission_data / item / type: ADDRESS
Create ATS Application — request body — body data notes item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
richtext_content | string | Required within parent | The richtext content of the note |
Create ATS Application — 201 response body — data
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
candidate_id | string | Required within parent | Candidate unique identifier Format: uuid |
created_at | string | Required within parent | Creation timestamp Format: date-time |
current_application_interview_plan_stage_id | JSON | Required within parent | |
current_application_interview_plan_stage_id (anyOf 1) | string | Alternative | Current interview plan stage identifier Format: uuid |
current_application_interview_plan_stage_id (anyOf 2) | null | Alternative | Current interview plan stage identifier Format: uuid |
id | string | Required within parent | Application unique identifier Format: uuid |
job_employment_type_id | JSON | Required within parent | |
job_employment_type_id (anyOf 1) | string | Alternative | Job employment type identifier Format: uuid |
job_employment_type_id (anyOf 2) | null | Alternative | Job employment type identifier Format: uuid |
job_id | string | Required within parent | Job unique identifier Format: uuid |
job_posting_id | JSON | Required within parent | |
job_posting_id (anyOf 1) | string | Alternative | Job posting unique identifier Format: uuid |
job_posting_id (anyOf 2) | null | Alternative | Job posting unique identifier Format: uuid |
moved_to_current_stage_at | JSON | Required within parent | |
moved_to_current_stage_at (anyOf 1) | string | Alternative | When application moved to current stage Format: date-time |
moved_to_current_stage_at (anyOf 2) | null | Alternative | When application moved to current stage Format: date-time |
numeric_id | JSON | Required within parent | |
numeric_id (anyOf 1) | integer | Alternative | Application numeric identifier |
numeric_id (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
source_slug | JSON | Optional | |
source_slug (anyOf 1) | string | Alternative | The application source slug in uppercase |
source_slug (anyOf 2) | null | Alternative | The application source slug in uppercase |
updated_at | string | Required within parent | Last update timestamp Format: date-time |
Create ATS Application — request body — body / data / application_form_submission_data / item / type: FREETEXT
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
answer | string | Required within parent | Text answer |
question_id | string | Required within parent | Question identifier |
type | string | Required within parent | Question type this answer belongs to. One of: FREETEXT |
Create ATS Application — request body — body / data / application_form_submission_data / item / type: PARAGRAPH
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
answer | string | Required within parent | Paragraph answer |
question_id | string | Required within parent | Question identifier |
type | string | Required within parent | Question type this answer belongs to. One of: PARAGRAPH |
Policy, approvals and errors
Section titled “Policy, approvals and errors”SDK function policy ID: deel.atsapplications_createatsapplication_v2026_01_01. Catalog operation: atsapplications_createatsapplication_v2026_01_01. 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-01-01"}