Skip to content

Deel: Create a stage move for an application

Deel ats.moveApplicationBetweenActiveInterviewPlanStages: arguments, response, policy and SDK examples.

← ATS operations · Get started

Operation deel.ats_moveapplicationbetweenactiveinterviewplanstages_v2026_11_02

Provider route: POST /ats/applications/{application_id}/stage-moves. 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["ats"]["moveApplicationBetweenActiveInterviewPlanStages"]>[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.ats.moveApplicationBetweenActiveInterviewPlanStages(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.move_application_between_active_interview_plan_stages(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
headersobjectRequired within parentAdditional keys: not allowed
headers.X-BetastringRequired within parentDefault: true
One of: true
bodyobjectOptional
body.dataModelRequired within parentExpand Create a stage move for an application — request body — body data

Referenced models: Create a stage move for an 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 a stage move for an application — 201 response body

Referenced models: Create a stage move for an application — 201 response body

Create a stage move for an application — 201 response body
FieldTypePresenceDescription and constraints
$objectRoot
dataModelRequired within parentExpand Create a stage move for an application — 201 response body — data
The application's new current interview plan stage record

Referenced models: Create a stage move for an application — 201 response body — data

Create a stage move for an application — request body — body data
FieldTypePresenceDescription and constraints
$objectRoot
applicable_job_activitiesarrayOptionalOptional array of job activities to trigger when the application enters the 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 Create a stage move for an application — request body — body data applicable job activities item
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 move the application to. Stages of the completed category are rejected.
Format: uuid

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

Create a stage move for an application — 201 response body — data
FieldTypePresenceDescription and constraints
$objectRootThe application's new current interview plan stage record
created_atstringRequired within parentThe timestamp when the record was created
Format: date-time
idstringRequired within parentThe ID of the application's new current 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
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
job_activity_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

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.ats_moveapplicationbetweenactiveinterviewplanstages_v2026_11_02. Catalog operation: ats_moveapplicationbetweenactiveinterviewplanstages_v2026_11_02. 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-11-02"}

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.