Skip to content

Deel: Update time-off request — request body — body data

Update time-off request: request body, field body / data. Complete fields and constraints for contract 2026-10-27.

API reference · Contract 2026-10-27

SDK schema: Update time-off request — request body — body data

FieldTypePresenceDescription and constraints
$objectRootTime off update request data
contract_oidstring or nullOptionalContract id. This is the id of the contract associated with the time off request.
Maximum length: 24
custom_field_valuesarray or nullOptionalAnswers to the custom fields the request policy declares, addressed by custom field id.
custom_field_values[]ModelEach itemExpand Create time-off request — request body — body data custom field values item
datesarrayOptionalThe dates breakdown for the time off request.
dates[]ModelEach itemExpand Create time-off request — request body — body data dates item
deduction_amountstring or nullOptionalDeduction amount. Available for independent contractor’s policies
descriptionstring or nullOptionalDescription of the time off request. Some policies require that a description is provided.
Maximum length: 500
end_dateModelRequired within parentExpand Create time-off request — request body — body data end date
End date of the time off request. This is the date when the time off ends. For example, if you take 2 days off, this will be the end date of the second day.
event_detailsModelOptionalExpand Update time-off request — request body — body data event details
Details of the event associated with the time off request. Required for event based policies such as parental leave.
is_paidbooleanOptionalWhether the time off is paid or unpaid. By default it follows the policy configuration.
other_type_descriptionstring or nullOptionalDescription of the time off type. This is used when the policy is OTHER.
Maximum length: 255
policy_idstringOptionalThe time off policy id. Can be used in place of time_off_type_id
Format: uuid
reasonstring or nullOptionalReason for taking time off. This is complementary information for the time-off description. Useful to provide sub categories for the same policy.
Maximum length: 500
recipient_profile_idstringRequired within parentThe hris profile id of the recipient
Format: uuid
start_dateModelRequired within parentExpand Create time-off request — request body — body data start date
Start date of the time off request. This is the date when the time off starts. For example, if you take 2 days off, this will be the start date of the first day.
time_off_event_idstringOptionalThe time off event id. This is used to link the time off request to an event.
Format: uuid
time_off_percentagenumber or nullOptionalThis is the percentage of time off taken. This is used when the time off request is a percentage.
Format: double
Maximum: 1
Minimum: 0
time_off_type_idstringOptionalThe time off type id. Required when policy_id is not provided
Format: uuid

Referenced models: Create time-off request — request body — body data custom field values item, Create time-off request — request body — body data dates item, Create time-off request — request body — body data end date, Create time-off request — request body — body data start date, Update time-off request — request body — body data event details

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.