Skip to content

Deel: Add external Id — request body — body data

Add external Id: request body, field body / data. Complete fields and constraints for contract 2026-10-27.

API reference · Contract 2026-10-27

SDK schema: 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.

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.