Skip to content

Update a work order bid

Work module

PATCH/work-order-bids/{id}workOrderBids.update

A bid on a work order. 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 work.work_order.write.
  • OAuth scopes: work.
  • 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

workOrderBids.update: Path and query parameters
FieldTypeRequiredDescription
idstring (uuid)YesIdentifier of the work order bid.

Request body: WorkOrderBidUpdate

workOrderBids.update: WorkOrderBidUpdate
FieldTypeRequiredDescription
amount_minorinteger (int64) | nullNoBid amount. Integer minor units of the resource currency; null means unpriced, never zero.
currencystringNoISO 4217 currency code of every money field.Constraints: pattern ^[A-Z]{3}$
notesstring | nullNoBid notes.Constraints: length 1 to 20000
{
  "amount_minor": 790000,
  "currency": "USD",
  "notes": "Includes delivery and install."
}

Response 200: WorkOrderBid

workOrderBids.update: WorkOrderBid
FieldTypeRequiredDescription
idstring (uuid)YesIdentifier of the work order bid.
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.
work_order_idstring (uuid)YesIdentifier of the work order.
bidder_organization_idstring (uuid)YesIdentifier of the bidding organization.
amount_minorinteger (int64) | nullYesBid amount. 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}$
bid_statestringYesBid state. A Title Case value from the lifecycle's database enum.Constraints: pattern ^[A-Z0-9][A-Za-z0-9&'/.()-]*( [A-Za-z0-9&'/.()-]+)*$
notesstring | nullYesBid notes.Constraints: length 1 to 20000
{
  "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",
  "work_order_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "bidder_organization_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "amount_minor": 790000,
  "currency": "USD",
  "bid_state": "Quoted",
  "notes": "Includes delivery and install."
}

Code samples

curl -X PATCH "$XOS_BASE_URL/work-order-bids/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 '{"amount_minor":790000,"currency":"USD","notes":"Includes delivery and install."}'
const { data, etag } = await xos.workOrderBids.update("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", {
    "amount_minor": 790000,
    "currency": "USD",
    "notes": "Includes delivery and install."
  }, { ifMatch: etag });
response = xos.work_order_bids.update("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", {"amount_minor": 790000, "currency": "USD", "notes": "Includes delivery and install."}, if_match=etag)
xos work-order-bids update 0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f --data '{"amount_minor":790000,"currency":"USD","notes":"Includes delivery and install."}' --if-match auto