Skip to content

Transition the rfq state

Procurement module

POST/rfqs/{id}/transitionsrfqs.transition

Moves the rfq lifecycle to another state through its transition RPC, which writes the transition ledger. Uses compare-and-set on `expected_state`; a disallowed transition returns a 422 refusal. Requires `Idempotency-Key`; a replay returns the original response. A rule that refuses the request returns 422 with `refusal` and `reason`.

  • Requires the capability procurement.rfq.write.
  • OAuth scopes: procurement.
  • 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

rfqs.transition: Path and query parameters
FieldTypeRequiredDescription
idstring (uuid)YesIdentifier of the rfq.

Request body: RFQTransitionRequest

rfqs.transition: RFQTransitionRequest
FieldTypeRequiredDescription
expected_statestringYesThe state the caller believes the row is in (compare-and-set).Constraints: pattern ^[A-Z][A-Za-z]*( [A-Z][A-Za-z]*)*$
to_statestringYesTarget state.Constraints: pattern ^[A-Z][A-Za-z]*( [A-Z][A-Za-z]*)*$
reasonstringNoReason, required by some transitions.Constraints: length 1 to any
{
  "expected_state": "Issued",
  "to_state": "Closed",
  "reason": "Client approved the revised scope."
}

Response 200: Rfq

rfqs.transition: Rfq
FieldTypeRequiredDescription
idstring (uuid)YesIdentifier of the rfq.
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.
project_idstring (uuid)YesIdentifier of the project.
titlestringYesRFQ title.Constraints: length 1 to 300
rfq_state"Proposed" | "Issued" | "Closed" | "Awarded" | "Canceled"YesRFQ state.
rfq_numberintegerYesNumber from the project's display key sequence.Constraints: range 1 to any
responses_due_atstring (date-time) | nullYesDeadline for responses; responses unseal when the RFQ closes.
{
  "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",
  "project_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "title": "Main Stage Audio Package",
  "rfq_state": "Proposed",
  "rfq_number": 3,
  "responses_due_at": "2026-10-08T14:30:00Z"
}

Code samples

curl -X POST "$XOS_BASE_URL/rfqs/0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f/transitions" \
  -H "Authorization: Bearer $XOS_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{"expected_state":"Issued","to_state":"Closed","reason":"Client approved the revised scope."}'
const { data } = await xos.rfqs.transition("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", {
    "expected_state": "Issued",
    "to_state": "Closed",
    "reason": "Client approved the revised scope."
  });
response = xos.rfqs.transition("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", {"expected_state": "Issued", "to_state": "Closed", "reason": "Client approved the revised scope."})
xos rfqs transition 0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f --data '{"expected_state":"Issued","to_state":"Closed","reason":"Client approved the revised scope."}'