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.
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["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 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.move_application_between_active_interview_plan_stages(arguments) result = await call.wait() return result.body_json()| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
path | object | Required within parent | Additional keys: not allowed |
path.application_id | string | Required within parent | Format: uuid |
headers | object | Required within parent | Additional keys: not allowed |
headers.X-Beta | string | Required within parent | Default: true One of: true |
body | object | Optional | |
body.data | Model | Required within parent | Expand 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
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 a stage move for an application — 201 response body |
Referenced models: Create a stage move for an application — 201 response body
Schemas
Section titled “Schemas”Create a stage move for an application — 201 response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | Model | Required within parent | Expand 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
applicable_job_activities | array | Optional | Optional 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[] | Model | Each item | Expand Create a stage move for an application — request body — body data applicable job activities item |
expected_current_interview_plan_stage_id | string | Optional | Optional 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_id | string | Required within parent | The 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | The application's new current interview plan stage record |
created_at | string | Required within parent | The timestamp when the record was created Format: date-time |
id | string | Required within parent | The ID of the application's new current interview plan stage record Format: uuid |
updated_at | string | Required within parent | The 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
candidate_self_scheduling_email_template_id | string | Optional | Optional custom email template ID for candidate self-scheduling (only applicable for interview scheduling activities) Format: uuid |
job_activity_id | string | Required within parent | The ID of the job activity to trigger Format: uuid |
participants | array | Optional | Optional array of custom participants for this activity. If not provided, the default participants from the job activity template will be used. |
participants[] | Model | Each item | Expand 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
participant_hris_organization_user_id | string | Required within parent | The HRIS organization user ID of the participant Format: uuid |
role_slug | string | Required within parent | The role of the participant in the activity One of: REVIEWER, INTERVIEWER |
Policy, approvals and errors
Section titled “Policy, approvals and errors”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"}