POST /rest/v2.0/companies/{company_id}/workflows/instances/{id}/responses
Respond to an instance
Servers
- https://api.procore.com
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
id |
String | Yes |
Unique identifier for the resource. |
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 |
|---|---|---|---|
comment |
String | No |
A note about this response |
attachments |
Object | Yes |
Attachments associated with this response |
attachments.file_version_ids[] |
Array | No |
List of file version IDs |
attachments.prostore_file_ids[] |
Array | No |
List of Procore Store file IDs |
attachments.form_ids[] |
Array | No |
List of form IDs |
attachments.image_ids[] |
Array | No |
List of image IDs |
attachments.upload_ids[] |
Array | No |
List of upload IDs |
attachments.drawing_revision_ids[] |
Array | No |
List of drawing revision IDs |
selected_response_option_id |
String | Yes |
ID of the selected response option |
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.