Skip to content

Deel: Assign application to interview plan stage

Deel atsApplications.associateApplicationWithAnInterviewPlanStage: arguments, response, policy and SDK examples.

← ATS applications operations · Get started

Operation deel.atsapplications_associateapplicationwithaninterviewplanstage_v2026_01_01

Provider route: POST /ats/applications/{application_id}/interview-plan-stages. 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"]["associateApplicationWithAnInterviewPlanStage"]>[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.associateApplicationWithAnInterviewPlanStage(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.associate_application_with_an_interview_plan_stage(arguments)
result = await call.wait()
return result.body_json()
FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
pathobjectRequired within parentAdditional keys: not allowed
path.application_idstringRequired within parentFormat: uuid
bodyobjectOptional
body.dataModelRequired within parentExpand Assign application to interview plan stage — request body — body data

Referenced models: Assign application to interview plan stage — 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 Assign application to interview plan stage — 201 response body

Referenced models: Assign application to interview plan stage — 201 response body

Assign application to interview plan stage — request body — body data
FieldTypePresenceDescription and constraints
$objectRoot
applicable_job_activitiesarrayOptionalOptional array of job activities to trigger when associating the application with this stage. If not provided, all activities will be triggered. If an empty array is provided, no activities will be triggered.
applicable_job_activities[]ModelEach itemExpand Assign application to interview plan stage — request body — body data applicable job activities item
candidate_archivation_email_template_idstringOptionalOptional ID of the rejection email template if the candidate is being archived
Format: uuid
candidate_archivation_reason_idstringOptionalOptional ID of the archivation reason if the candidate is being archived
Format: uuid
creator_idstringOptionalIgnored. The move is always recorded as made by the calling user, service accounts included.
Format: uuid
delay_amountintegerOptionalThe amount of time to delay the archivation email. Must be provided together with delay_unit. Cannot be used together with scheduled_send_at.
Maximum: 100
Minimum: 1
delay_unitstringOptionalThe unit of time for the delay. Must be provided together with delay_amount. Cannot be used together with scheduled_send_at.
One of: hours, days, weeks
expected_current_interview_plan_stage_idstringOptionalOptional precondition: the application's current interview plan stage ID as last read. If the application has moved since, nothing changes and a 409 precondition_failed is returned.
Format: uuid
interview_plan_stage_idstringRequired within parentThe ID of the interview plan stage to associate with the application
Format: uuid
is_current_stagebooleanRequired within parentWhen true, sets this stage as the application's current stage in the hiring workflow. When false, creates a historical record without changing the application's current stage.
scheduled_send_atstringOptionalThe exact future datetime to send the archivation email. Cannot be used together with delay_amount/delay_unit.
Format: date-time

Referenced models: Assign application to interview plan stage — request body — body data applicable job activities item

Assign application to interview plan stage — 201 response body
FieldTypePresenceDescription and constraints
$objectRoot
dataModelRequired within parentExpand Assign application to interview plan stage — 201 response body — data
The created application interview plan stage record

Referenced models: Assign application to interview plan stage — 201 response body — data

Assign application to interview plan stage — request body — body data applicable job activities item
FieldTypePresenceDescription and constraints
$objectRoot
candidate_self_scheduling_email_template_idstringOptionalOptional custom email template ID for candidate self-scheduling (only applicable for interview scheduling activities)
Format: uuid
idstringRequired within parentThe ID of the job activity to trigger
Format: uuid
participantsarrayOptionalOptional array of custom participants for this activity. If not provided, the default participants from the job activity template will be used.
participants[]ModelEach itemExpand Create a stage move for an application — request body — body data applicable job activities item participants item

Referenced models: Create a stage move for an application — request body — body data applicable job activities item participants item

Assign application to interview plan stage — 201 response body — data
FieldTypePresenceDescription and constraints
$objectRootThe created application interview plan stage record
created_atstringRequired within parentThe timestamp when the record was created
Format: date-time
idstringRequired within parentThe unique identifier of the created application interview plan stage record
Format: uuid
updated_atstringRequired within parentThe timestamp when the record was last updated
Format: date-time
Create a stage move for an application — request body — body data applicable job activities item participants item
FieldTypePresenceDescription and constraints
$objectRoot
participant_hris_organization_user_idstringRequired within parentThe HRIS organization user ID of the participant
Format: uuid
role_slugstringRequired within parentThe role of the participant in the activity
One of: REVIEWER, INTERVIEWER

SDK function policy ID: deel.atsapplications_associateapplicationwithaninterviewplanstage_v2026_01_01. Catalog operation: atsapplications_associateapplicationwithaninterviewplanstage_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.