POST /rest/v1.0/projects/{project_id}/rfis
Creates a new RFI in a specified Project.
Servers
- https://api.procore.com
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
project_id |
Integer | Yes |
Unique identifier for the project. |
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. |
Query parameters
| Name | Type | Required | Description |
|---|---|---|---|
run_configurable_validations |
Boolean | No |
If true, validations are run for the corresponding Configurable Field Set. Default value: false |
Request body fields
| Name | Type | Required | Description |
|---|---|---|---|
rfi |
Object | Yes | |
rfi.draft |
Boolean | No |
The Draft status of the RFI Default value: false |
rfi.rfi_manager_id |
Integer | Yes |
The ID of the RFI Manager User of the RFI *Only admin users (or standard users, if the project's configuration allows for it) can set this field |
rfi.specification_section_id |
Integer | No |
The ID of the Specification Section of the RFI |
rfi.number |
String | No |
The Number of the RFI *This field will be auto-populated if the RFI is not draft |
rfi.custom_textfield_2 |
String | No |
The Custom Textfield 2 of the RFI |
rfi.custom_textfield_1 |
String | No |
The Custom Textfield 1 of the RFI |
rfi.assignee_ids[] |
Array | No |
An array of IDs of the Assignees of the RFI *Only admin users can set this field **If this param is not provided, the assigned_id will be used instead |
rfi.subject |
String | Yes |
The Subject of the RFI |
rfi.cost_impact |
Object | No |
The Cost Impact of the RFI |
rfi.cost_impact.status |
String | No |
The Status of the Cost Impact Possible values:
|
rfi.cost_impact.value |
Number | No |
Cost impact value in dollars |
rfi.custom_field_%{custom_field_definition_id} |
No |
Value of the custom field. The data type of the value passed in corresponds with the data_type of the Custom Field Definition. For a lov_entry data_type the value passed in should be the ID of one of the Custom Field Definition's LOV Entries. For a lov_entries data_type the value passed in should be an array of IDs of the Custom Field Definition's LOV Entries. |
|
rfi.distribution_ids[] |
Array | No |
An array of IDs of the Distributions of the RFI |
rfi.schedule_impact |
Object | No |
The Schedule Impact of the RFI |
rfi.schedule_impact.status |
String | No |
The Status of the Schedule Impact Possible values:
|
rfi.schedule_impact.value |
Integer | No |
The Value in days of the Schedule Impact |
rfi.location_id |
Integer | No |
The ID of the Location of the RFI |
rfi.received_from_login_information_id |
Integer | No |
The ID of the Received From User of the RFI |
rfi.assignee_id |
Integer | No |
The ID of the Assignee User. *Only admin users can set this field DEPRECATED. Please use assignee_ids instead |
rfi.project_stage_id |
Integer | No |
The ID of the Project Stage of the RFI *If Number By Stage is enabled in RFI settings, this will add the prefix of the project stage to the full number of the RFI. |
rfi.private |
Boolean | No |
The Private status of the RFI Default value: false |
rfi.question |
Object | Yes |
The Question of the RFI |
rfi.question.file_version_ids[] |
Array | No |
File Versions to attach to the response |
rfi.question.prostore_file_ids[] |
Array | No |
An array of Prostore File IDs. The Prostore Files will be associated with the RFI as attachments. |
rfi.question.form_ids[] |
Array | No |
Forms to attach to the response |
rfi.question.image_ids[] |
Array | No |
Images to attach to the response |
rfi.question.document_management_document_revision_ids[] |
Array | No |
Document Management Document Revisions to attach to the response |
rfi.question.attachments[] |
Array | No |
RFI Question Attachments. To upload attachments you must upload the entire payload as |
rfi.question.upload_ids[] |
Array | No |
Uploads to attach to the response |
rfi.question.body |
String | Yes |
The Body of the Question |
rfi.question.drawing_revision_ids[] |
Array | No |
Drawing Revisions to attach to the response |
rfi.reference |
String | No |
The Reference of the RFI |
rfi.responsible_contractor_id |
Integer | No |
The ID of the Responsible Contractor Vendor of the RFI |
rfi.drawing_number |
String | No |
The Drawing Number of the RFI |
rfi.required_assignee_ids[] |
Array | No |
An array of IDs of the Assignees that are required to respond to the RFI * Only admin users can set this field ** IDs must also be present in assignee_ids |
rfi.due_date |
String | No |
The Due Date of the RFI *Only admin users can set this field |
rfi.cost_code_id |
Integer | No |
The ID of the Cost Code of the RFI |
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.