Skip to content

Deel: Add external Id

Deel contracts.updateIccontract: arguments, response, policy and SDK examples.

← Contracts operations · Get started

Operation deel.contracts_updateiccontract

Provider route: PATCH /contracts/{contract_id}. 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["contracts"]["updateIccontract"]>[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.contracts.updateIccontract(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.contracts.update_iccontract(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 parent
bodyobjectOptional
body.dataModelRequired within parentExpand Add external Id — request body — body data

Referenced models: Add external Id — 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 Add external Id — 200 response body

Referenced models: Add external Id — 200 response body

17 more schemas are linked from the tables above, on the schema pages.

Add external Id — request body — body data
FieldTypePresenceDescription and constraints
$objectRoot
external_idstring or nullRequired within parentA unique identifier for the object provided by an external system. Use or send null when you want to reset the external id.
Add external Id — 200 response body
FieldTypePresenceDescription and constraints
$objectRoot
clientJSONRequired within parentClient details associated with the contract.
client (anyOf 1)ModelAlternativeExpand Add external Id — 200 response body — client Client details associated with the contract
client (anyOf 2)nullAlternative
compensation_detailsModelOptionalExpand Add external Id — 200 response body — compensation details
Compensation and payment configuration for the contract.
contract_templateJSONOptionalContract template details.
contract_template (anyOf 1)ModelAlternativeExpand Add external Id — 200 response body — contract template Contract template details
contract_template (anyOf 2)nullAlternative
cost_centersarrayOptionalList of cost centers associated with the contract.
cost_centers[]ModelEach itemExpand Add external Id — 200 response body — cost centers item
created_atstringRequired within parentDate and time when the contract was created.
Format: date-time
custom_fieldsJSONOptional
custom_fields (anyOf 1)arrayAlternativeList of custom fields attached to the contract.
custom_fields (anyOf 1)[]ModelEach itemExpand Create a new contract — 201 response body — data custom fields item
custom_fields (anyOf 2)nullAlternativeList of custom fields attached to the contract.
custom_fields (anyOf 2)[]ModelEach itemExpand Create a new contract — 201 response body — data custom fields item
employment_detailsModelOptionalExpand Add external Id — 200 response body — employment details
Employment-related details for the contract.
employment_typeJSONOptionalType of employment.
employment_type (anyOf 1)stringAlternativeType of employment.
Known values: FULL_TIME, PART_TIME
employment_type (anyOf 2)nullAlternative
external_idJSONOptional
external_id (anyOf 1)stringAlternativeExternal identifier of the contract.
external_id (anyOf 2)nullAlternativeExternal identifier of the contract.
idstringRequired within parentUnique identifier for the contract.
Minimum length: 1
invitationsModelRequired within parentExpand Add external Id — 200 response body — invitations
Invitation email addresses for signing the contract.
is_archivedJSONRequired within parent
is_archived (anyOf 1)booleanAlternativeFlag to indicate if the contract is archived.
is_archived (anyOf 2)nullAlternativeFlag to indicate if the contract is archived.
job_titlestringOptionalJob title associated with the contract.
notice_periodJSONOptional
notice_period (anyOf 1)JSONAlternative
notice_period (anyOf 1) (anyOf 1)numberAlternativeNotice period in days.
Format: double
notice_period (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
notice_period (anyOf 2)nullAlternativeNotice period in days.
Format: double
quoteModelOptionalExpand Add external Id — 200 response body — quote
EOR quote approved by Deel.
scope_of_workJSONOptional
scope_of_work (anyOf 1)stringAlternativeScope of work of the contract.
scope_of_work (anyOf 2)nullAlternativeScope of work of the contract.
seniorityJSONOptionalSeniority describes level of expertise at a job e.g. junior.
seniority (anyOf 1)ModelAlternativeExpand Add external Id — 200 response body — seniority id, level, name
seniority (anyOf 2)nullAlternative
signaturesModelRequired within parentExpand Add external Id — 200 response body — signatures
Signature information for the contract parties.
special_clauseJSONRequired within parent
special_clause (anyOf 1)stringAlternativeSpecial clause of the contract.
special_clause (anyOf 2)nullAlternativeSpecial clause of the contract.
start_datestringRequired within parentDate and time when the contract starts.
Format: date-time
statusModelRequired within parentExpand Add external Id — 200 response body — status
Status of a contract in Deel workflow.
termination_dateJSONRequired within parent
termination_date (anyOf 1)stringAlternativeDate and time when the contract ends.
termination_date (anyOf 2)nullAlternativeDate and time when the contract ends.
titlestringRequired within parentTitle of the contract.
Minimum length: 1
typestringRequired within parentType of a contract.
Known values: ongoing_time_based, milestones, time_based, pay_as_you_go_time_based, commission, payg_milestones, payg_tasks, contractor_outside_deel, eor, unknown, employee, global_payroll, shield_msa, hris_direct_employee, peo
updated_atstringRequired within parentDate and time when the contract was updated.
Format: date-time
who_reportsstringOptionalWho reports the hours.
work_scheduleJSONOptionalDefines a work schedule including working days, hours, and employment details
work_schedule (anyOf 1)ModelAlternativeExpand Add external Id — 200 response body — work schedule country, days, employment type, name, work hours per week, work schedule type, worker types
work_schedule (anyOf 2)nullAlternative
work_statement_idJSONOptional
work_statement_id (anyOf 1)stringAlternativeThe unique identifier of the associated work statement.
work_statement_id (anyOf 2)nullAlternativeThe unique identifier of the associated work statement.
workerJSONRequired within parentWorker details associated with the contract.
worker (anyOf 1)ModelAlternativeExpand Add external Id — 200 response body — worker Worker details associated with the contract
worker (anyOf 2)nullAlternative

Referenced models: Add external Id — 200 response body — contract template Contract template details, Create a new contract — 201 response body — data custom fields item, Add external Id — 200 response body — compensation details, Add external Id — 200 response body — cost centers item, Add external Id — 200 response body — invitations, Add external Id — 200 response body — quote, Add external Id — 200 response body — seniority id, level, name, Add external Id — 200 response body — signatures, Add external Id — 200 response body — status, Add external Id — 200 response body — client Client details associated with the contract, Add external Id — 200 response body — employment details, Add external Id — 200 response body — work schedule country, days, employment type, name, work hours per week, work schedule type, worker types, Add external Id — 200 response body — worker Worker details associated with the contract

Add external Id — 200 response body — contract template Contract template details
FieldTypePresenceDescription and constraints
$objectRootContract template details.
idstringOptionalUnique identifier of a contract template.
titlestringOptionalTitle of a contract template
Create a new contract — 201 response body — data custom fields item
FieldTypePresenceDescription and constraints
$objectRootCustomized attributes on contracts (Employee ID, Project code, etc).
namestringOptionalCustom field property name.
valuestringOptionalCustom field property value.
Add external Id — 200 response body — cost centers item
FieldTypePresenceDescription and constraints
$objectRoot
allocation_percentageJSONOptional
allocation_percentage (anyOf 1)numberAlternativePercentage of the cost center allocation.
Format: double
allocation_percentage (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
namestringOptionalCost center name.
numberstringOptionalCost center number.

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