POST /rest/v1.0/projects/{project_id}/submittals
Create a new Submittal associated with the 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 |
|---|---|---|---|
send_emails |
Boolean | No |
Designates whether or not emails will be sent (default false) |
Request body fields
| Name | Type | Required | Description |
|---|---|---|---|
submittal |
Object | No | |
submittal.specification_section_id |
Integer | No |
The ID of the Specification Section of the Submittal |
submittal.lead_time |
Integer | No |
The Lead Time of the Submittal (in days) *This field can only be set by admins or if the project has schedule calculations enabled |
submittal.description |
String | No |
The Description of the Submittal |
submittal.distribution_member_ids[] |
Array | No |
The IDs of the Distribution Members of the Submittal |
submittal.custom_textfield_1 |
String | No |
*This field can only be set by admins |
submittal.buffer_time |
Integer | No |
The buffer working days for the dynamic submittal plan calculation *This field is only available to be set if Dynamic Submittal Plan is enabled |
submittal.issue_date |
String | No |
The Issue Date of the Submittal *This field can only be set by admins |
submittal.scheduled_task_key |
String | No |
The key of the Scheduled Task of the Submittal. Note that use of this parameter is deprecated. Please use |
submittal.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. |
|
submittal.required_on_site_date |
String | No |
The Required On Site Date of the Submittal *This field can only be set by admins or if the project has schedule calculations enabled |
submittal.submittal_package_id |
Integer | No |
The ID of the Submittal Package of the Submittal *This field can only be set by admins |
submittal.received_date |
String | No |
The Received Date of the Submittal *This field can only be set by admins |
submittal.title |
String | No |
The Title of the Submittal |
submittal.type |
String | No |
The Submittal Type of the Submittal |
submittal.submit_by |
String | No |
The Submit By Date of the Submittal *This field can only be set by admins |
submittal.actual_delivery_date |
String | No |
The Actual Delivery Date of the Submittal *This field can only be set if the project has submittal delivery information enabled |
submittal.prostore_file_ids[] |
Array | No |
An array of Prostore File IDs. The Prostore Files will be associated with the Submittal as attachments. |
submittal.scheduled_task_id |
Integer | No |
The ID of the Scheduled Task of the Submittal *This field can only be set if the project has submittal delivery information enabled and the user has permissions to view the calendar tool |
submittal.sub_job_id |
Integer | No |
The ID of the Sub Job of the Submittal |
submittal.revision |
String | No |
The Revision of the Submittal |
submittal.number |
String | Yes |
The Number of the Submittal |
submittal.status_id |
Integer | No |
The ID of the Submittal Status of the Submittal *This field can only be set by admins |
submittal.source_submittal_revision_id |
Integer | No |
The ID of the latest Submittal Revision. |
submittal.confirmed_delivery_date |
String | No |
The Confirmed Delivery Date of the Submittal *This field can only be set if the project has submittal delivery information enabled |
submittal.custom_textarea_1 |
String | No |
*This field can only be set by admins |
submittal.location_id |
Integer | No |
The Location of the Submittal |
submittal.submittal_manager_id |
Integer | No |
The ID of the Submittal Manager of the Submittal *This field can only be set by admins |
submittal.source_submittal_log_id |
Integer | No |
The ID of the Source Submittal. *By setting this field, the submittal will be created as a revision of source submittal. |
submittal.for_record_only |
Boolean | No |
The field that controls if the dynamic submittal plan is for record only or not *This field is only available to be set if Dynamic Submittal Plan is enabled |
submittal.private |
Boolean | No |
Whether the Submittal is Private or not |
submittal.internal_review_time |
Integer | No |
The Internal Review Time of the Submtital (in days) *This field can only be set if the project has schedule calculations enabled |
submittal.responsible_contractor_id |
Integer | No |
The Responsible Contractor of the Submittal |
submittal.received_from_id |
Integer | No |
The Received From of the Submittal |
submittal.cost_code_id |
Integer | No |
The ID of the Cost Code of the Submittal *This field can only be set by admins |
submittal.design_team_review_time |
Integer | No |
The Design Team Review Time of the Submittal (in days) *This field can only be set if the project has schedule calculations enabled |
submittal.due_date |
String | No |
The Due Date of the Submittal *This field is not available to be set if sequential approvers is enabled |
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.