Deel: Create an offer for an application in the offer stage
Deel ats.createOfferForApplicationInOfferStage: arguments, response, policy and SDK examples.
← ATS operations · Get started
Operation deel.ats_createofferforapplicationinofferstage_v2026_11_02
Provider route: POST /ats/applications/{application_id}/offers. 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"]["createOfferForApplicationInOfferStage"]>[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.createOfferForApplicationInOfferStage(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.create_offer_for_application_in_offer_stage(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 an offer for an application in the offer stage — request body — body data |
Referenced models: Create an offer for an application in the offer stage — 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 an offer for an application in the offer stage — 201 response body |
Referenced models: Create an offer for an application in the offer stage — 201 response body
Schemas
Section titled “Schemas”Create an offer for an application in the offer stage — request body — body data
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
additional_details | string or null | Optional | Additional details shown with the offer |
approval_policy_id | string or null | Optional | ID of the approval policy the offer goes through, for organizations that use approval policies Format: uuid |
approval_rule_id | string or null | Optional | ID of the approval rule the offer goes through, for organizations that use approval rules Format: uuid |
compensation_amount | number | Required within parent | Compensation amount for the period Format: double |
compensation_currency | string | Required within parent | ISO 4217 currency code of the compensation |
compensation_period_slug | string | Optional | Period the compensation amount covers One of: annually, monthly, semimonthly, biweekly, weekly, daily, hourly |
country_code | string | Required within parent | ISO 3166-1 alpha-2 code of the country the candidate will work in Format: country-code |
expires_at | string or null | Optional | Date the offer expires once sent if the candidate has not answered Format: date |
job_title | string | Required within parent | Job title offered to the candidate |
offer_letter_template_id | string or null | Optional | ID of the offer letter template to attach. Archived templates are rejected. Format: uuid |
opening_id | string or null | Optional | ID of the job opening the offer fills Format: uuid |
start_date | string | Required within parent | Proposed start date of the candidate Format: date-time |
worker_type | string | Required within parent | How the candidate will be hired One of: CONTRACTOR_FIXED, CONTRACTOR_PAY_AS_YOU_GO, CONTRACTOR_MILESTONE, DIRECT_EMPLOYEE, EOR_EMPLOYEE, GLOBAL_PAYROLL_EMPLOYEE, PEO_EMPLOYEE, PWAC |
Create an offer for an application in the offer stage — 201 response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | Model | Required within parent | Expand Create an offer for an application in the offer stage — 201 response body — data The created offer |
Referenced models: Create an offer for an application in the offer stage — 201 response body — data
Create an offer for an application in the offer stage — 201 response body — data
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | The created offer |
application_interview_plan_stage_id | string | Required within parent | ID of the application's offer stage record the offer belongs to Format: uuid |
approval_policy_id | JSON | Required within parent | |
approval_policy_id (anyOf 1) | string | Alternative | ID of the approval policy applied to the offer Format: uuid |
approval_policy_id (anyOf 2) | null | Alternative | ID of the approval policy applied to the offer Format: uuid |
approval_request_id | JSON | Required within parent | |
approval_request_id (anyOf 1) | string | Alternative | ID of the approval request opened for an approval rule Format: uuid |
approval_request_id (anyOf 2) | null | Alternative | ID of the approval request opened for an approval rule Format: uuid |
approval_rule_id | JSON | Required within parent | |
approval_rule_id (anyOf 1) | string | Alternative | ID of the approval rule applied to the offer Format: uuid |
approval_rule_id (anyOf 2) | null | Alternative | ID of the approval rule applied to the offer Format: uuid |
created_at | string | Required within parent | Timestamp when the offer was created Format: date-time |
id | string | Required within parent | ID of the created offer Format: uuid |
offer_status | string | Required within parent | Status of the new offer: WAITING_FOR_APPROVAL when an approval applies, otherwise CREATED Known values: CREATED, WAITING_FOR_APPROVAL |
Policy, approvals and errors
Section titled “Policy, approvals and errors”SDK function policy ID: deel.ats_createofferforapplicationinofferstage_v2026_11_02. Catalog operation: ats_createofferforapplicationinofferstage_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"}