PUT /rest/v2.0/companies/{company_id}/workflows/bulk_replace_requests/{id}
Updates an existing workflows bulk replace request. This API validates the input, updates the request record in the DB, and creates a new async operation record. The request must be temporary to be updated. The replacement type and original assignee cannot be changed. This API will queue another async operation even if the update does not introduce any changes, effectively "retrying" a request that previously contained errors.
Servers
- https://api.procore.com
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
id |
String | Yes |
Unique identifier for the workflow bulk replace request. |
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 | No |
Array of IDs for new assignees |
start_date |
String | No |
Start date for temporary replacements |
end_date |
String | No |
End date for temporary replacements |
modify_project_roles |
Boolean | No |
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) |
reason |
String | No |
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.