Deel: Set the time of an interview
Deel ats.scheduleOrRescheduleInterview: arguments, response, policy and SDK examples.
← ATS operations · Get started
Operation deel.ats_scheduleorrescheduleinterview_v2026_11_02
Provider route: PATCH /ats/applications/{application_id}/application-activities/{application_activity_id}/scheduled-interviews. 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"]["scheduleOrRescheduleInterview"]>[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.scheduleOrRescheduleInterview(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.schedule_or_reschedule_interview(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 |
path.application_activity_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 Set the time of an interview — request body — body data |
Referenced models: Set the time of an interview — 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 Set the time of an interview — 200 response body |
Referenced models: Set the time of an interview — 200 response body
Schemas
Section titled “Schemas”Set the time of an interview — request body — body data
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
expected_starts_at | string or null | Optional | Optional precondition: the interview's starts_at as last read, or null when it was not scheduled. If it changed since, nothing is booked and a 409 precondition_failed is returned. Format: date-time |
starts_at | string | Required within parent | Start of the interview, normally the start_time of an available slot Format: date-time |
timezone | string | Required within parent | IANA timezone of the interview, used in the invitations |
Set the time of an interview — 200 response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | Model | Required within parent | Expand Set the time of an interview — 200 response body — data The scheduled interview |
Referenced models: Set the time of an interview — 200 response body — data
Set the time of an interview — 200 response body — data
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | The scheduled interview |
application_activity_id | string | Required within parent | ID of the interview scheduling activity of the application Format: uuid |
id | string | Required within parent | Unique identifier of the interview Format: uuid |
starts_at | JSON | Required within parent | |
starts_at (anyOf 1) | string | Alternative | Start of the interview as booked Format: date-time |
starts_at (anyOf 2) | null | Alternative | Start of the interview as booked Format: date-time |
Policy, approvals and errors
Section titled “Policy, approvals and errors”SDK function policy ID: deel.ats_scheduleorrescheduleinterview_v2026_11_02. Catalog operation: ats_scheduleorrescheduleinterview_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"}