Award a work order bid
Work module
POST/work-order-bids/{id}/awardworkOrderBids.award
Awards the work order to this bid and closes the other bids. Requires `Idempotency-Key`; a replay returns the original response. A rule that refuses the request returns 422 with `refusal` and `reason`.
- Requires the capability work.work_order.award.
- OAuth scopes: work.
- Send an Idempotency-Key header. A replay with the same key returns the original response.
- Error statuses: 400, 401, 404, 409, 422, 429. Errors are RFC 9457 problem details.
Path and query parameters
| Field | Type | Required | Description |
|---|---|---|---|
| id | string (uuid) | Yes | Identifier of the work order bid. |
Response 200: WorkOrderBid
| Field | Type | Required | Description |
|---|---|---|---|
| id | string (uuid) | Yes | Identifier of the work order bid. |
| org_id | string (uuid) | Yes | Identifier of the owning organization, derived from the parent row and never accepted from the caller. |
| created_at | string (date-time) | Yes | When the row was created. |
| created_by | string (uuid) | null | Yes | Identifier of the person who created the row; null when a seed, platform or system process created it. |
| updated_at | string (date-time) | Yes | When the row was last updated. |
| updated_by | string (uuid) | null | Yes | Identifier of the person who last updated the row; null when a seed, platform or system process updated it. |
| work_order_id | string (uuid) | Yes | Identifier of the work order. |
| bidder_organization_id | string (uuid) | Yes | Identifier of the bidding organization. |
| amount_minor | integer (int64) | null | Yes | Bid amount. Integer minor units of the resource currency; null means unpriced, never zero. |
| currency | string | Yes | ISO 4217 currency code of every money field.Constraints: pattern ^[A-Z]{3}$ |
| bid_state | string | Yes | Bid state. A Title Case value from the lifecycle's database enum.Constraints: pattern ^[A-Z0-9][A-Za-z0-9&'/.()-]*( [A-Za-z0-9&'/.()-]+)*$ |
| notes | string | null | Yes | Bid 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 POST "$XOS_BASE_URL/work-order-bids/0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f/award" \
-H "Authorization: Bearer $XOS_API_KEY" \
-H "Idempotency-Key: $(uuidgen)"const { data } = await xos.workOrderBids.award("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f");response = xos.work_order_bids.award("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f")xos work-order-bids award 0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f