POST /rest/v2.0/companies/{company_id}/projects/{project_id}/workflows/instances/{id}/restart
Terminates the current instance and restarts a new instance from the beginning. Returns the new instance information.
Idempotency: If the instance has already been restarted (i.e., it is already terminated and an active sibling instance exists), the endpoint returns 200 OK with the previously created instance instead of creating a duplicate. This makes the operation safe to retry.
Servers
- https://api.procore.com
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
id |
String | Yes |
Unique identifier for the workflow instance. |
project_id |
String | Yes |
Unique identifier for the project. |
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 |
|---|---|---|---|
restart_mode |
String | No |
Controls how the new workflow instance is configured. Valid values:
Default value: "defaults" |
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.