Skip to content

Create a bid

Opportunities module

POST/bidsbids.create

A sealed line-item bid. A bidder never sees another bidder, and the org sees bids only after the deadline unless it holds `procurement.bid.unseal`. Creates a bid. Requires `Idempotency-Key`; a replay returns the original response. The organization is derived from the credential or the parent row, never from the body.

  • Requires the capability me.work_details.write.
  • OAuth scopes: me.
  • Send an Idempotency-Key header. A replay with the same key returns the original response.
  • Error statuses: 400, 401, 409, 422, 429. Errors are RFC 9457 problem details.

Request body: BidCreate

bids.create: BidCreate
FieldTypeRequiredDescription
application_idstring (uuid)YesIdentifier of the application.
currency_codestringYesISO 4217 currency of every line.Constraints: pattern ^[A-Z]{3}$
valid_untilstring (date) | nullNoLast day the bid holds.
{
  "application_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "currency_code": "USD",
  "valid_until": "2026-10-08"
}

Response 201: Bid

bids.create: Bid
FieldTypeRequiredDescription
idstring (uuid)YesIdentifier of the 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.
application_idstring (uuid)YesIdentifier of the application.
totalMoneyTotalYesA money aggregate that never coerces unpriced inputs to zero.
sealedbooleanYesWhether the bid is still sealed.
currency_codestringYesISO 4217 currency of every line.Constraints: pattern ^[A-Z]{3}$
valid_untilstring (date) | nullYesLast day the bid holds.
submitted_atstring (date-time)YesWhen the bid was submitted, set by the database.
{
  "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",
  "application_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "total": {
    "total_minor": 1250000,
    "currency": "USD",
    "unpriced_count": 2
  },
  "sealed": true,
  "currency_code": "USD",
  "valid_until": "2026-10-08",
  "submitted_at": "2026-10-08T14:30:00Z"
}

Code samples

curl -X POST "$XOS_BASE_URL/bids" \
  -H "Authorization: Bearer $XOS_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{"application_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f","currency_code":"USD","valid_until":"2026-10-08"}'
const { data } = await xos.bids.create({
    "application_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
    "currency_code": "USD",
    "valid_until": "2026-10-08"
  });
response = xos.bids.create({"application_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", "currency_code": "USD", "valid_until": "2026-10-08"})
xos bids create --data '{"application_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f","currency_code":"USD","valid_until":"2026-10-08"}'