Skip to content

Deel: Validate offer terms for an application

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

← ATS operations · Get started

Operation deel.ats_validateoffertermsforapplication_v2026_11_02

Provider route: POST /ats/applications/{application_id}/offer-validations. 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"]["validateOfferTermsForApplication"]>[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.validateOfferTermsForApplication(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.validate_offer_terms_for_application(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 Validate offer terms for an application — request body — body data

Referenced models: Validate offer terms 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 Validate offer terms for an application — 200 response body

Referenced models: Validate offer terms for an application — 200 response body

Validate offer terms for an application — request body — body data
FieldTypePresenceDescription and constraints
$objectRoot
compensation_amountnumberRequired within parentCompensation amount for the period
Format: double
compensation_currencystringRequired within parentISO 4217 currency code of the compensation
compensation_period_slugstringOptionalPeriod the compensation amount covers
One of: annually, monthly, semimonthly, biweekly, weekly, daily, hourly
country_codestringRequired within parentISO 3166-1 alpha-2 code of the country the candidate will work in
Format: country-code
job_titlestring or nullOptionalJob title offered to the candidate
start_datestringRequired within parentProposed start date of the candidate
Format: date-time
statestring or nullOptionalState or region code within the country, where the rules depend on it
worker_typestringRequired within parentHow 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
Validate offer terms for an application — 200 response body
FieldTypePresenceDescription and constraints
$objectRoot
dataModelRequired within parentExpand Validate offer terms for an application — 200 response body — data
Outcome of the validation

Referenced models: Validate offer terms for an application — 200 response body — data

Validate offer terms for an application — 200 response body — data
FieldTypePresenceDescription and constraints
$objectRootOutcome of the validation
errorsarrayRequired within parentRules the terms break; empty when the terms are valid
errors[]ModelEach itemExpand Validate offer terms for an application — 200 response body — data errors item
is_validbooleanRequired within parentWhether the terms satisfy every rule

Referenced models: Validate offer terms for an application — 200 response body — data errors item

Validate offer terms for an application — 200 response body — data errors item
FieldTypePresenceDescription and constraints
$objectRoot
codestringRequired within parentMachine-readable code of the broken rule
fieldJSONRequired within parent
field (anyOf 1)stringAlternativeRequest field the error is about, or null when it concerns the terms as a whole
field (anyOf 2)nullAlternativeRequest field the error is about, or null when it concerns the terms as a whole
messagestringRequired within parentExplanation of the broken rule to show to the user

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