POST /rest/v2.0/companies/{company_id}/workflows/bulk_replace_requests
Creates a new workflows bulk replace request to replace assignees across workflow instances.
Servers
- https://api.procore.com
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
company_id |
String | Yes |
Unique identifier for the company. |
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 |
|---|---|---|---|
new_assignee_ids[] |
Array | Yes |
Array of IDs for new assignees |
start_date |
String | No |
Start date for temporary replacements |
replacement_type |
String | Yes |
Type of replacement (temporary or permanent) Valid values:
|
end_date |
String | No |
End date for temporary replacements |
modify_project_roles |
Boolean | Yes |
Whether to modify project roles during replacement |
tools[] |
Array | No |
Array of tool configurations to limit replacement scope (optional) |
tools[].sub_type |
String | No |
Tool sub-type |
tools[].type |
String | No |
Tool type |
new_workflow_manager_id |
String | No |
ID of the new workflow manager (optional) |
project_ids[] |
Array | No |
Array of project IDs to limit replacement scope (optional) |
old_assignee_id |
String | Yes |
ID of the assignee to be replaced |
reason |
String | Yes |
Reason for the replacement |
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.