POST /rest/v2.0/companies/{company_id}/projects/{project_id}/workflows/instances
Creates a new workflow instance for a given project. The template_id and preset_id options can be used to specify a specific template. If neither are specified, the default preset will be used. If both are specified, the preset_id will be used.
Servers
- https://api.procore.com
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
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 |
|---|---|---|---|
tool_type |
String | Yes |
The type of tool for the workflow instance. |
tool_subtype |
String | No |
The subtype of the tool. Required when tool_type is 'correspondence'. |
item_id |
String | Yes |
The ID of the item to associate with the workflow instance. |
preset_id |
String | No |
Optional. Specific preset ID to use for the workflow instance. Takes precedence over template_id if both are provided. |
template_id |
String | No |
Optional. Specific template ID to use for the workflow instance. |
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.