Update Submittal
update_submittalUpdate an existing submittal in Procore by providing the project ID, submittal ID, and number. Modify fields like description, due date, status, and more.
Instructions
Update the specified Submittal. Note: Updating the workflow_data field is only supported when using the multipart/form-data request format. If you attempt to update workflow_data using a JSON request format, the request will fail with a 400 Bad Request response, along with the error message: "Error Updating Approvers.". Use this to update an existing Submittals (only the supplied fields are changed). Updates the specified Submittals and returns the modified object on success. Required parameters: project_id, id, number. Procore API (v1.1): Project Management > Submittals. Endpoint: PATCH /rest/v1.1/projects/{project_id}/submittals/{id}
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| project_id | Yes | URL path parameter — unique identifier for the project. | |
| id | Yes | URL path parameter — unique identifier of the Submittals resource | |
| send_emails | No | Query string parameter — designates whether or not emails will be sent (default false) | |
| actual_delivery_date | No | JSON request body field — the Actual Delivery Date of the Submittal *This field can only be set if the project has submittal delivery information enabled | |
| attachments | No | JSON request body field — submittal attachments. To upload attachments you must upload the entire payload as `multipart/form-data` content-type and specify each parameter as form-data together with `attachments[]` as files. | |
| confirmed_delivery_date | No | JSON request body field — the Confirmed Delivery Date of the Submittal *This field can only be set if the project has submittal delivery information enabled | |
| cost_code_id | No | JSON request body field — the ID of the Cost Code of the Submittal *This field can only be set by admins | |
| custom_textarea_1 | No | JSON request body field — *This field can only be set by admins | |
| custom_textfield_1 | No | JSON request body field — *This field can only be set by admins | |
| description | No | JSON request body field — the Description of the Submittal | |
| design_team_review_time | No | JSON request body field — the Design Team Review Time of the Submittal (in days) *This field can only be set if the project has schedule calculations enabled | |
| distribution_member_ids | No | JSON request body field — the IDs of the Distribution Members of the Submittal | |
| due_date | No | JSON request body field — the Due Date of the Submittal *This field is not available to be set if sequential approvers is enabled | |
| internal_review_time | No | JSON request body field — the Internal Review Time of the Submtital (in days) *This field can only be set if the project has schedule calculations enabled | |
| issue_date | No | JSON request body field — the Issue Date of the Submittal *This field can only be set by admins | |
| lead_time | No | JSON request body field — the Lead Time of the Submittal (in days) *This field can only be set by admins or if the project has schedule calculations enabled | |
| location_id | No | JSON request body field — the Location of the Submittal | |
| number | Yes | JSON request body field — the Number of the Submittal | |
| private | No | JSON request body field — whether the Submittal is Private or not | |
| prostore_file_ids | No | JSON request body field — an array of Prostore File IDs. The Prostore Files will be associated with the Submittal as attachments. | |
| received_date | No | JSON request body field — the Received Date of the Submittal *This field can only be set by admins | |
| received_from_id | No | JSON request body field — the Received From of the Submittal | |
| required_on_site_date | No | JSON request body field — the Required On Site Date of the Submittal *This field can only be set by admins or if the project has schedule calculations enabled | |
| responsible_contractor_id | No | JSON request body field — the Responsible Contractor of the Submittal | |
| revision | No | JSON request body field — the Revision of the Submittal | |
| scheduled_task_key | No | JSON request body field — the key of the Scheduled Task of the Submittal. Note that use of this parameter is deprecated. Please use `scheduled_task_id` instead. *This field can only be set if the project has submittal deliv... | |
| scheduled_task_id | No | JSON request body field — 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 | |
| source_submittal_log_id | No | JSON request body field — the ID of the Source Submittal. *By setting this field, the submittal will be created as a revision of source submittal. | |
| specification_section_id | No | JSON request body field — the ID of the Specification Section of the Submittal | |
| status_id | No | JSON request body field — the ID of the Submittal Status of the Submittal *This field can only be set by admins | |
| sub_job_id | No | JSON request body field — the ID of the Sub Job of the Submittal | |
| submit_by | No | JSON request body field — the Submit By Date of the Submittal *This field can only be set by admins |