POST /rest/v1.0/workforce-planning/v2/companies/{company_id}/people/{person_id}/time-off
Creates a new Time Off entry for a specified Person within a given company.
Servers
- https://api.procore.com
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
person_id |
Integer | Yes |
Unique identifier for the person |
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 | Yes |
The end date of the time off. |
apply_to_sunday |
Boolean | No |
Whether the time off applies to Sundays. |
cadence |
Integer | No |
Cadence of the repeating time off. |
batch_end_time |
String | No |
End time of the time off (HH:MM am/pm). |
is_paid |
Boolean | No |
Whether the time off is paid. |
reason |
String | No |
The reason for the time off. |
repeat |
String | No |
Repeat interval of the time off instances. Possible values:
|
start_day |
String | Yes |
The start date of the time off. |
batch_start_time |
String | No |
Start time of the time off (HH:MM am/pm). |
repeat_end_day |
String | No |
The end date of the repeating time off. |
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.