PATCH /rest/v1.1/projects/{project_id}/bid_packages/{bid_package_id}/bid_forms/{bid_form_id}

Update single Bid Form.

Servers

Path parameters

Name Type Required Description
project_id Integer Yes

Unique identifier for the project.

bid_package_id Integer Yes

Bid Package ID

bid_form_id Integer Yes

Bid Form ID

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
lock_unit_fields_alternates Boolean No

Lock unit fields for all alternate items

proposal_id Integer No

Proposal ID

lock_quantity_fields_base_bid Boolean No

Lock quantity fields for all base bid items

lock_quantity_fields_alternates Boolean No

Lock quantity fields for all alternate items

title String Yes

Bid Form Title

lock_unit_fields_base_bid Boolean No

Lock unit fields for all base bid items

alternates[] Array No

Alternate bids

alternates[].bid_form_items[] Array No

Bid Form Items

alternates[].bid_form_items[].description String No

Bid Form Item Description

alternates[].bid_form_items[].layer_id Integer No

ID of the Layer in the Estimate

alternates[].bid_form_items[].locked_quantity Number No

Locked quantity value that cannot be changed by bidders when submitting bids

alternates[].bid_form_items[].subject String No

Subject for Plain Text Items.

alternates[].bid_form_items[].position Integer No

Position

alternates[].bid_form_items[].estimated_unit_of_measure String No

Unit of Measure from the Layer of an Estimate

alternates[].bid_form_items[].locked_unit_of_measure String No

Locked unit of measure that cannot be changed by bidders when submitting bids

alternates[].bid_form_items[].id Integer No

ID

alternates[].bid_form_items[].item_type String No

Bid Form Items can be of various types. This property does determine which one is used.

Valid values:

  • "cost_code"
  • "plain_text"
alternates[].bid_form_items[].estimated_unit_cost Number No

Estimated Unit from the Layer of an Estimate

alternates[].bid_form_items[].response_type String No

Bid Form Items can have various response types. This property determines which one is used.

Valid values:

  • "unit"
  • "include_exclude"
  • "amount"
alternates[].bid_form_items[].estimated_amount Number No

Amount from the Layer of an Estimate

alternates[].bid_form_items[].estimated_quantity Number No

Quantity from the Layer of an Estimate

alternates[].bid_form_items[].cost_code_id Integer No

Cost Code ID

alternates[].header Boolean No

Whether the item is a header or not

alternates[].sub_sections[] Array No

Sub Sections

alternates[].sub_sections[].id Integer No

ID

alternates[].sub_sections[].bid_form_items[] Array No

Bid Form Items

alternates[].sub_sections[].bid_form_items[].description String No

Bid Form Item Description

alternates[].sub_sections[].bid_form_items[].layer_id Integer No

ID of the Layer in the Estimate

alternates[].sub_sections[].bid_form_items[].locked_quantity Number No

Locked quantity value that cannot be changed by bidders when submitting bids

alternates[].sub_sections[].bid_form_items[].subject String No

Subject for Plain Text Items.

alternates[].sub_sections[].bid_form_items[].position Integer No

Position

alternates[].sub_sections[].bid_form_items[].estimated_unit_of_measure String No

Unit of Measure from the Layer of an Estimate

alternates[].sub_sections[].bid_form_items[].locked_unit_of_measure String No

Locked unit of measure that cannot be changed by bidders when submitting bids

alternates[].sub_sections[].bid_form_items[].item_type String No

Bid Form Items can be of various types. This property does determine which one is used.

Valid values:

  • "cost_code"
  • "plain_text"
alternates[].sub_sections[].bid_form_items[].estimated_unit_cost Number No

Estimated Unit from the Layer of an Estimate

alternates[].sub_sections[].bid_form_items[].response_type String No

Bid Form Items can have various response types. This property determines which one is used.

Valid values:

  • "unit"
  • "include_exclude"
  • "amount"
alternates[].sub_sections[].bid_form_items[].estimated_amount Number No

Amount from the Layer of an Estimate

alternates[].sub_sections[].bid_form_items[].estimated_quantity Number No

Quantity from the Layer of an Estimate

alternates[].sub_sections[].bid_form_items[].cost_code_id Integer No

Cost Code ID

alternates[].sub_sections[].title String No

Sub Section Title

alternates[].sub_sections[].position Integer No

Position

alternates[].title String No

Alternate Bid Form Item Title

alternates[].position Integer No

Position

base_bid[] Array No

Base Bids

base_bid[].bid_form_items[] Array No

Bid Form Items

base_bid[].bid_form_items[].description String No

Bid Form Item Description

base_bid[].bid_form_items[].layer_id Integer No

ID of the Layer in the Estimate

base_bid[].bid_form_items[].locked_quantity Number No

Locked quantity value that cannot be changed by bidders when submitting bids

base_bid[].bid_form_items[].subject String No

Subject for Plain Text Items.

base_bid[].bid_form_items[].position Integer No

Position

base_bid[].bid_form_items[].estimated_unit_of_measure String No

Unit of Measure from the Layer of an Estimate

base_bid[].bid_form_items[].locked_unit_of_measure String No

Locked unit of measure that cannot be changed by bidders when submitting bids

base_bid[].bid_form_items[].id Integer No

ID

base_bid[].bid_form_items[].item_type String No

Bid Form Items can be of various types. This property does determine which one is used.

Valid values:

  • "cost_code"
  • "plain_text"
base_bid[].bid_form_items[].estimated_unit_cost Number No

Estimated Unit from the Layer of an Estimate

base_bid[].bid_form_items[].response_type String No

Bid Form Items can have various response types. This property determines which one is used.

Valid values:

  • "unit"
  • "include_exclude"
  • "amount"
base_bid[].bid_form_items[].estimated_amount Number No

Amount from the Layer of an Estimate

base_bid[].bid_form_items[].estimated_quantity Number No

Quantity from the Layer of an Estimate

base_bid[].bid_form_items[].cost_code_id Integer No

Cost Code ID

base_bid[].header Boolean No

Whether the item is a header or not

base_bid[].sub_sections[] Array No

Sub Sections

base_bid[].sub_sections[].id Integer No

ID

base_bid[].sub_sections[].bid_form_items[] Array No

Bid Form Items

base_bid[].sub_sections[].bid_form_items[].description String No

Bid Form Item Description

base_bid[].sub_sections[].bid_form_items[].layer_id Integer No

ID of the Layer in the Estimate

base_bid[].sub_sections[].bid_form_items[].locked_quantity Number No

Locked quantity value that cannot be changed by bidders when submitting bids

base_bid[].sub_sections[].bid_form_items[].subject String No

Subject for Plain Text Items.

base_bid[].sub_sections[].bid_form_items[].position Integer No

Position

base_bid[].sub_sections[].bid_form_items[].estimated_unit_of_measure String No

Unit of Measure from the Layer of an Estimate

base_bid[].sub_sections[].bid_form_items[].locked_unit_of_measure String No

Locked unit of measure that cannot be changed by bidders when submitting bids

base_bid[].sub_sections[].bid_form_items[].item_type String No

Bid Form Items can be of various types. This property does determine which one is used.

Valid values:

  • "cost_code"
  • "plain_text"
base_bid[].sub_sections[].bid_form_items[].estimated_unit_cost Number No

Estimated Unit from the Layer of an Estimate

base_bid[].sub_sections[].bid_form_items[].response_type String No

Bid Form Items can have various response types. This property determines which one is used.

Valid values:

  • "unit"
  • "include_exclude"
  • "amount"
base_bid[].sub_sections[].bid_form_items[].estimated_amount Number No

Amount from the Layer of an Estimate

base_bid[].sub_sections[].bid_form_items[].estimated_quantity Number No

Quantity from the Layer of an Estimate

base_bid[].sub_sections[].bid_form_items[].cost_code_id Integer No

Cost Code ID

base_bid[].sub_sections[].title String No

Sub Section Title

base_bid[].sub_sections[].position Integer No

Position

base_bid[].title String No

Base Bid Form Item Title

base_bid[].position Integer No

Position

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. 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.
  3. Click Test request to test run your request to the API and see the API's response.