Skip to content

Deel: Update time-off request — 200 response body — time off

Update time-off request: 200 response body, field time_off. Complete fields and constraints for contract 2026-10-27.

API reference · Contract 2026-10-27

SDK schema: Update time-off request — 200 response body — time off

FieldTypePresenceDescription and constraints
$objectRootUsed to return the updated time off request after modification. Contains all the time off details including status, dates, amounts, and associated metadata.
amountstringRequired within parentAmount of time off taken. This is the total amount of time off taken. For example, if you take 2 days off, this will be 2. If you take 1 day off, this will be 1.
approved_atJSONOptional
approved_at (anyOf 1)stringAlternativeThis is the date when the time off request was approved. This will be null if the time off request is not approved yet.
Format: date-time
approved_at (anyOf 2)nullAlternativeThis is the date when the time off request was approved. This will be null if the time off request is not approved yet.
Format: date-time
attachmentsarrayOptionalList of attachments associated with the time off request.
attachments[]ModelEach itemExpand Update time-off request — 200 response body — time off attachments item
canceled_atJSONOptional
canceled_at (anyOf 1)stringAlternativeTime off cancellation date
Format: date-time
canceled_at (anyOf 2)nullAlternativeTime off cancellation date
Format: date-time
contract_oidstringOptionalContract id. This is the id of the contract associated with the time off request.
created_atstringRequired within parentThis is the date when the time off request was created in the database.
Format: date-time
custom_field_valuesarrayOptionalAnswers to the custom fields the request policy declares. Omitted when the policy declares none.
custom_field_values[]ModelEach itemExpand Update time-off request — 200 response body — time off custom field values item
deduction_amountstringOptionalDeduction amount. Available for independent contractor’s policies
deleted_atJSONOptional
deleted_at (anyOf 1)stringAlternativeTime off deletion date. Present only when the time-off is soft-deleted and include_deleted_time_offs was requested.
Format: date-time
deleted_at (anyOf 2)nullAlternativeTime off deletion date. Present only when the time-off is soft-deleted and include_deleted_time_offs was requested.
Format: date-time
descriptionstringOptionalDescription of the time off request. Some policies require that a description is provided.
end_datestringRequired within parentEnd 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.
Format: date
entitlement_unitstringRequired within parentThe unit in which the time off usage and entitlement are calculated.
Known values: HOUR, BUSINESS_DAY, CALENDAR_DAY, WEEK, MONTH, YEAR
half_end_datebooleanRequired within parentWhether the end date is a half day or not.
half_start_datebooleanRequired within parentWhether the start date is a half day or not.
is_end_date_estimatedbooleanOptionalUsed to indicate if the end date is an estimate rather than a confirmed date. This is particularly important for event-based policies such as Parental Leave, where the actual end date may depend on the actual birth or adoption date, which may not be known at the time of request submission.
is_paidbooleanRequired within parentWhether the time off is paid or unpaid.
other_type_descriptionstringOptionalUsed to provide a custom description when the time off type is categorized as ‘OTHER’. This allows users to specify the nature of time off that doesn’t fit into standard categories, providing flexibility for unique or organization-specific time off types.
reasonstringOptionalReason for taking time off. This is complementary information for the time-off description. Useful to provide sub categories for the same policy.
recipient_profileModelOptionalExpand Update time-off request — 200 response body — time off recipient profile
The time off profile of the recipient of the time off request. Must be a worker profile.
requested_atstringRequired within parentThis is the date when the time off request was made.
Format: date
requester_profileModelOptionalExpand Update time-off request — 200 response body — time off requester profile
The time off profile of the requester of the time off request. Can be either a client or worker profile.
start_datestringRequired within parentStart 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.
Format: date
statusstringOptionalStatus of the time off request. Can be REQUESTED, APPROVED, REJECTED, USED or CANCELED.
Known values: REQUESTED, APPROVED, REJECTED, USED, CANCELED, DELETED
time_off_dailiesarrayOptionalUsed to break down the time off request into daily records. Each entry represents a single day within the time off period, allowing for detailed tracking of working days, non-working days, and holidays included in the request.
time_off_dailies[]ModelEach itemExpand Update time-off request — 200 response body — time off time off dailies item
time_off_eventModelOptionalExpand Update time-off request — 200 response body — time off time off event
time_off_percentagestringOptionalUsed to specify the percentage of time off taken relative to full-time employment. This value ranges from 0 to 1, where 1 represents full-time (100%) and 0.5 represents part-time (50%). This is useful for part-time workers or when taking partial time off.
time_off_typeModelOptionalExpand Update time-off request — 200 response body — time off time off type
The type of time off taken.
time_off_type_idstringRequired within parentTime off type id. This is the id of the time off type associated with the time off request.
Format: uuid
updated_atstringRequired within parentThis is the date when the time off request was last updated in the database.
Format: date-time

Referenced models: Update time-off request — 200 response body — time off custom field values item, Update time-off request — 200 response body — time off attachments item, Update time-off request — 200 response body — time off recipient profile, Update time-off request — 200 response body — time off requester profile, Update time-off request — 200 response body — time off time off dailies item, Update time-off request — 200 response body — time off time off event, Update time-off request — 200 response body — time off time off type

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.