POST /rest/v2.0/companies/{company_id}/projects/{project_id}/workflows/instances/{id}/responses
Submit a response for the current step of a workflow instance.
Idempotency: If the user has already submitted a response for the current step, the behavior depends on whether the resubmitted payload matches the original:
-
Identical resubmission (same response option and comment): returns 204 No Content as a successful no-op, making the operation safe to retry.
-
Conflicting resubmission (different response option or comment): returns 422 Unprocessable Entity, since the response has already been recorded with different values.
Servers
- https://api.procore.com
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
id |
String | Yes |
Unique identifier for the resource. |
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 |
|---|---|---|---|
response |
Object | Yes |
The response object |
response.comment |
String | No |
A note about this response |
response.attachments |
Object | Yes |
Attachments associated with this response |
response.attachments.file_version_ids[] |
Array | No |
List of file version IDs |
response.attachments.prostore_file_ids[] |
Array | No |
List of Procore Store file IDs |
response.attachments.form_ids[] |
Array | No |
List of form IDs |
response.attachments.image_ids[] |
Array | No |
List of image IDs |
response.attachments.upload_ids[] |
Array | No |
List of upload IDs |
response.attachments.drawing_revision_ids[] |
Array | No |
List of drawing revision IDs |
response.selected_response_option_id |
String | Yes |
ID of the selected response option |
response.current_step_occurrence_id |
String | Yes |
ID of the current step occurrence |
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.