PATCH /rest/v1.0/workforce-planning/v2/companies/{company_id}/people/{person_id}/time-off/{time_off_id}
Updates an existing Time Off record for a specified Person within a given company. Only specified properties in the request body will be updated.
Servers
- https://api.procore.com
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
person_id |
Integer | Yes |
Unique identifier for the person |
time_off_id |
String | Yes |
The UUID of the Time Off record. |
company_id |
Yes |
Unique identifier for the company. This parameter accepts both formats:
A proxy layer automatically handles both formats, but using the Procore company ID is preferred for consistency with other Procore APIs. |
Request headers
| Name | Type | Required | Description |
|---|---|---|---|
Content-Type |
String | Yes |
The media type of the request body.
Default value: "application/json" |
Procore-Company-Id |
Integer | Yes |
Unique company identifier associated with the Procore User Account. |
Request body fields
| Name | Type | Required | Description |
|---|---|---|---|
apply_to_saturday |
Boolean | No |
Whether the time off applies to Saturdays. |
end_day |
String | No |
End date of the time off (MM/DD/YY). |
apply_to_sunday |
Boolean | No |
Whether the time off applies to Sundays. |
batch_end_time |
String | No |
End time of the time off (formatted as HH:MM am/pm). |
is_paid |
Boolean | No |
Whether the time off is paid. |
reason |
String | No |
Reason for the time off. |
start_day |
String | No |
Start date of the time off (MM/DD/YY). |
batch_start_time |
String | No |
Start time of the time off (formatted as HH:MM am/pm). |
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.