Skip to content

Deel: Add external Id — 200 response body — invitations

Add external Id: 200 response body, field invitations. Complete fields and constraints for contract 2026-10-27.

API reference · Contract 2026-10-27

SDK schema: Add external Id — 200 response body — invitations

FieldTypePresenceDescription and constraints
$objectRootInvitation email addresses for signing the contract.
client_emailJSONOptional
client_email (anyOf 1)stringAlternativeUser’s email address.
client_email (anyOf 2)nullAlternativeUser’s email address.
worker_emailJSONOptional
worker_email (anyOf 1)stringAlternativeUser’s email address.
worker_email (anyOf 2)nullAlternativeUser’s email address.

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.