Skip to content

Deel: Validate amendment data points

Deel eorAmendments.validateEoramendments: arguments, response, policy and SDK examples.

← EOR amendments operations · Get started

Operation deel.eoramendments_validateeoramendments

Provider route: POST /eor/contracts/{contract_id}/amendments/validate. 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["eorAmendments"]["validateEoramendments"]>[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.eorAmendments.validateEoramendments(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.eor_amendments.validate_eoramendments(arguments)
result = await call.wait()
return result.body_json()
FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
pathobjectRequired within parentAdditional keys: not allowed
path.contract_idstringRequired within parentFormat: alphanumeric
bodyobjectOptional
body.dataModelOptionalExpand Validate amendment data points — request body — body data
Amendment fields to validate. At least one of scope or job_title must be provided.

Referenced models: Validate amendment data points — 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 amendment data points — 200 response body

Referenced models: Validate amendment data points — 200 response body

Validate amendment data points — request body — body data
FieldTypePresenceDescription and constraints
$objectRootAmendment fields to validate. At least one of scope or job_title must be provided.
job_titlestringOptionalJob title to validate, up to 1,000 characters.
scopestringOptionalJob scope to validate, up to 20,000 characters.
Validate amendment data points — 200 response body
FieldTypePresenceDescription and constraints
$objectRoot
dataobjectOptionalValidation results keyed by amendment field
Additional keys: see wildcard field
data.*ModelAdditional keysExpand Validate amendment data points — 200 response body — data value

Referenced models: Validate amendment data points — 200 response body — data value

Validate amendment data points — 200 response body — data value
FieldTypePresenceDescription and constraints
$objectRoot
messageJSONOptional
message (anyOf 1)stringAlternativeValidation message for the field, present when the value is invalid.
message (anyOf 2)nullAlternativeValidation message for the field, present when the value is invalid.
validJSONOptional
valid (anyOf 1)booleanAlternativeWhether the submitted value for this field is valid.
valid (anyOf 2)nullAlternativeWhether the submitted value for this field is valid.

SDK function policy ID: deel.eoramendments_validateeoramendments. Catalog operation: eoramendments_validateeoramendments. 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: ["contracts:write"]

Pinned headers: {"X-Version": "2026-01-01"}

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.