Skip to content

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.

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

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

Referenced models: Create ATS Application — 201 response body

10 more schemas are linked from the tables above, on the schema pages.

Create ATS Application — request body — body data
FieldTypePresenceDescription and constraints
$objectRoot
application_form_submission_dataarray or nullOptionalArray of form submission answers
application_form_submission_data[]ModelEach itemExpand Create ATS Application — request body — body data application form submission data item
candidate_idstringRequired within parentThe ID of the candidate applying
Format: uuid
job_employment_type_idstringRequired within parentThe ID of the employment type for this job
Format: uuid
job_idstringRequired within parentThe ID of the job for this application
Format: uuid
job_posting_idstring or nullOptionalThe ID of the job posting (optional)
Format: uuid
notesarray or nullOptionalArray of notes to attach to the application
notes[]ModelEach itemExpand Create ATS Application — request body — body data notes item
source_slugstringOptionalThe 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
FieldTypePresenceDescription and constraints
$objectRootCreated application response
dataModelRequired within parentExpand 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
FieldTypePresenceDescription and constraints
$JSONRoot
$ (oneOf 1)ModelAlternativeExpand Create ATS Application — request body — body / data / application_form_submission_data / item / type: FREETEXT
$ (oneOf 2)ModelAlternativeExpand Create ATS Application — request body — body / data / application_form_submission_data / item / type: PARAGRAPH
$ (oneOf 3)ModelAlternativeExpand Create ATS Application — request body — body / data / application_form_submission_data / item / type: SINGLESELECTION
$ (oneOf 4)ModelAlternativeExpand Create ATS Application — request body — body / data / application_form_submission_data / item / type: MULTISELECTION
$ (oneOf 5)ModelAlternativeExpand Create ATS Application — request body — body / data / application_form_submission_data / item / type: DOCUMENTUPLOAD
$ (oneOf 6)ModelAlternativeExpand Create ATS Application — request body — body / data / application_form_submission_data / item / type: PRESETDROPDOWN
$ (oneOf 7)ModelAlternativeExpand Create ATS Application — request body — body / data / application_form_submission_data / item / type: CUSTOMDROPDOWN
$ (oneOf 8)ModelAlternativeExpand Create ATS Application — request body — body / data / application_form_submission_data / item / type: NUMBER
$ (oneOf 9)ModelAlternativeExpand Create ATS Application — request body — body / data / application_form_submission_data / item / type: DATEPICKER
$ (oneOf 10)ModelAlternativeExpand Create ATS Application — request body — body / data / application_form_submission_data / item / type: ADDRESS
$ (oneOf 11)ModelAlternativeExpand Create ATS Application — request body — body / data / application_form_submission_data / item / type: PHONENUMBER
$ (oneOf 12)ModelAlternativeExpand Create ATS Application — request body — body / data / application_form_submission_data / item / type: EMAIL

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
FieldTypePresenceDescription and constraints
$objectRoot
richtext_contentstringRequired within parentThe richtext content of the note
Create ATS Application — 201 response body — data
FieldTypePresenceDescription and constraints
$objectRoot
candidate_idstringRequired within parentCandidate unique identifier
Format: uuid
created_atstringRequired within parentCreation timestamp
Format: date-time
current_application_interview_plan_stage_idJSONRequired within parent
current_application_interview_plan_stage_id (anyOf 1)stringAlternativeCurrent interview plan stage identifier
Format: uuid
current_application_interview_plan_stage_id (anyOf 2)nullAlternativeCurrent interview plan stage identifier
Format: uuid
idstringRequired within parentApplication unique identifier
Format: uuid
job_employment_type_idJSONRequired within parent
job_employment_type_id (anyOf 1)stringAlternativeJob employment type identifier
Format: uuid
job_employment_type_id (anyOf 2)nullAlternativeJob employment type identifier
Format: uuid
job_idstringRequired within parentJob unique identifier
Format: uuid
job_posting_idJSONRequired within parent
job_posting_id (anyOf 1)stringAlternativeJob posting unique identifier
Format: uuid
job_posting_id (anyOf 2)nullAlternativeJob posting unique identifier
Format: uuid
moved_to_current_stage_atJSONRequired within parent
moved_to_current_stage_at (anyOf 1)stringAlternativeWhen application moved to current stage
Format: date-time
moved_to_current_stage_at (anyOf 2)nullAlternativeWhen application moved to current stage
Format: date-time
numeric_idJSONRequired within parent
numeric_id (anyOf 1)integerAlternativeApplication numeric identifier
numeric_id (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
source_slugJSONOptional
source_slug (anyOf 1)stringAlternativeThe application source slug in uppercase
source_slug (anyOf 2)nullAlternativeThe application source slug in uppercase
updated_atstringRequired within parentLast update timestamp
Format: date-time
Create ATS Application — request body — body / data / application_form_submission_data / item / type: FREETEXT
FieldTypePresenceDescription and constraints
$objectRoot
answerstringRequired within parentText answer
question_idstringRequired within parentQuestion identifier
typestringRequired within parentQuestion type this answer belongs to.
One of: FREETEXT
Create ATS Application — request body — body / data / application_form_submission_data / item / type: PARAGRAPH
FieldTypePresenceDescription and constraints
$objectRoot
answerstringRequired within parentParagraph answer
question_idstringRequired within parentQuestion identifier
typestringRequired within parentQuestion type this answer belongs to.
One of: PARAGRAPH

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

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.