Bids

Update bid

Partially updates a bid. Accepted bids are locked.

patch/bids/{id}

Request

Base URL: https://app.buildworkpro.com/api/v1
URL: https://app.buildworkpro.com/api/v1/bids/{id}
Auth: HTTP bearer

Path parameters

idinteger required

Headers

Idempotency-Keystring uuid

Idempotent retry key for mutating operations. The first request with a given key executes normally and BuildWorkPro caches the response. Replaying the same key with the same request body (method + path + JSON body, SHA-256 hashed) returns the cached response without re-executing the mutation. Replaying with a DIFFERENT body returns 409 idempotency_key_reused. The cache TTL is 24 hours; after expiry the key is treated as a new operation. Keys are tenant-scoped. Recommended: a fresh UUID v4 per logical operation.

Request body

bidNumberstring

namestring nullable

leadIdinteger nullable

contactIdinteger nullable

dueDatestring nullable

validUntilstring nullable

sentAtstring nullable

acceptedAtstring nullable

acceptedBystring nullable

rejectedAtstring nullable

cancelReasonstring nullable

cancelledAtstring nullable

cancelledFromStatusstring nullable

taxRatestring nullable

Bid-level sales tax rate. A percent, not a fraction: 7 means 7% (send 7, not 0.07). 0-100, at most 3 decimal places.

discountTypestring nullable

discountstring nullable

Discount amount, or a percent when discountType is "percentage". At most 2 decimal places.

siteAddressstring nullable

siteCitystring nullable

siteStatestring nullable

siteZipCodestring nullable

latitudestring nullable

longitudestring nullable

notesstring nullable

termsstring nullable

paymentTermsTextstring nullable

paymentTermIdinteger nullable

marginPercentstring nullable

Margin as a percent of the selling price (18 means 18%). At most 2 decimal places.

companyOhPercentstring nullable

Company overhead as a percent of the selling price (10 means 10%). At most 2 decimal places.

commissionPercentstring nullable

Sales commission as a percent of the selling price. At most 2 decimal places.

showSublinesboolean nullable

roundSalesAmountsboolean nullable

proposalDetail'total' | 'line_items' | 'full'

What the customer sees on the proposal PDF and share page: total (a scope paragraph and the totals, no line table), line_items (the line table, no sub-lines) or full (the line table with each line's sub-lines).

proposalShowQuantitiesboolean

Print the Qty column on the proposal.

proposalShowUnitPricesboolean

Print the Unit price column on the proposal.

kanbanOrderinteger

Response

Updated

Changes

No recorded changes to this operation across all 1 revision of this API.