Skip to content

Update a bid line

Opportunities module

PATCH/bid-lines/{id}bidLines.update

A line of a sealed bid. Updates the fields sent; omitted fields are unchanged. Requires `If-Match` with the current `ETag`: a stale tag returns 412 and a missing tag returns 428.

  • Requires the capability me.work_details.write.
  • OAuth scopes: me.
  • Send If-Match with the ETag you read. A stale tag returns 412; a missing tag returns 428.
  • Error statuses: 400, 401, 404, 412, 422, 428, 429. Errors are RFC 9457 problem details.

Path and query parameters

bidLines.update: Path and query parameters
FieldTypeRequiredDescription
idstring (uuid)YesIdentifier of the bid line.

Request body: BidLineUpdate

bidLines.update: BidLineUpdate
FieldTypeRequiredDescription
descriptionstringNoLine description.Constraints: length 1 to 300
quantitynumberNoQuantity; defaults to 1.
unit_price_minorinteger (int64) | nullNoUnit price. Integer minor units of the resource currency; null means unpriced, never zero.
{
  "description": "Line array rental",
  "quantity": 2,
  "unit_price_minor": 1800000
}

Response 200: BidLine

bidLines.update: BidLine
FieldTypeRequiredDescription
idstring (uuid)YesIdentifier of the bid line.
org_idstring (uuid)YesIdentifier of the owning organization, derived from the parent row and never accepted from the caller.
created_atstring (date-time)YesWhen the row was created.
created_bystring (uuid) | nullYesIdentifier of the person who created the row; null when a seed, platform or system process created it.
updated_atstring (date-time)YesWhen the row was last updated.
updated_bystring (uuid) | nullYesIdentifier of the person who last updated the row; null when a seed, platform or system process updated it.
bid_idstring (uuid)YesIdentifier of the bid.
descriptionstringYesLine description.Constraints: length 1 to 300
quantitynumberYesQuantity; defaults to 1.
unit_price_minorinteger (int64) | nullYesUnit price. Integer minor units of the resource currency; null means unpriced, never zero.
currencystringYesISO 4217 currency code of every money field.Constraints: pattern ^[A-Z]{3}$
{
  "id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "org_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "created_at": "2026-10-08T14:30:00Z",
  "created_by": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "updated_at": "2026-10-08T14:30:00Z",
  "updated_by": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "bid_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "description": "Line array rental",
  "quantity": 2,
  "unit_price_minor": 1800000,
  "currency": "USD"
}

Code samples

curl -X PATCH "$XOS_BASE_URL/bid-lines/0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f" \
  -H "Authorization: Bearer $XOS_API_KEY" \
  -H 'If-Match: W/"etag-from-your-last-read"' \
  -H "Content-Type: application/json" \
  -d '{"description":"Line array rental","quantity":2,"unit_price_minor":1800000}'
const { data, etag } = await xos.bidLines.update("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", {
    "description": "Line array rental",
    "quantity": 2,
    "unit_price_minor": 1800000
  }, { ifMatch: etag });
response = xos.bid_lines.update("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", {"description": "Line array rental", "quantity": 2, "unit_price_minor": 1800000}, if_match=etag)
xos bid-lines update 0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f --data '{"description":"Line array rental","quantity":2,"unit_price_minor":1800000}' --if-match auto