Skip to content

Create a bid line

Opportunities module

POST/bid-linesbidLines.create

A line of a sealed bid. Creates a bid line. 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: BidLineCreate

bidLines.create: BidLineCreate
FieldTypeRequiredDescription
bid_idstring (uuid)YesIdentifier of the bid.
descriptionstringYesLine 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.
{
  "bid_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "description": "Line array rental",
  "quantity": 2,
  "unit_price_minor": 1800000
}

Response 201: BidLine

bidLines.create: 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 POST "$XOS_BASE_URL/bid-lines" \
  -H "Authorization: Bearer $XOS_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{"bid_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f","description":"Line array rental","quantity":2,"unit_price_minor":1800000}'
const { data } = await xos.bidLines.create({
    "bid_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
    "description": "Line array rental",
    "quantity": 2,
    "unit_price_minor": 1800000
  });
response = xos.bid_lines.create({"bid_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", "description": "Line array rental", "quantity": 2, "unit_price_minor": 1800000})
xos bid-lines create --data '{"bid_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f","description":"Line array rental","quantity":2,"unit_price_minor":1800000}'