Skip to content

Decide a prequalification

Vendors module

POST/prequalifications/{id}/decideprequalifications.decide

Approves or rejects a pending prequalification through app.decide_prequalification: vendors.prequalification.approve, never by the requester, final once decided. A refusal returns 422 and names the rule. Requires `Idempotency-Key`; a replay returns the original response. A rule that refuses the request returns 422 with `refusal` and `reason`.

  • Requires the capability vendors.prequalification.approve.
  • OAuth scopes: vendors.
  • 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

prequalifications.decide: Path and query parameters
FieldTypeRequiredDescription
idstring (uuid)YesIdentifier of the prequalification.

Request body: PrequalificationDecideRequest

prequalifications.decide: PrequalificationDecideRequest
FieldTypeRequiredDescription
decision"Approved" | "Rejected"YesDecision.
valid_tostring (date)NoLast day an approval holds.
{
  "decision": "Approved",
  "valid_to": "2027-12-31"
}

Response 200: Prequalification

prequalifications.decide: Prequalification
FieldTypeRequiredDescription
idstring (uuid)YesIdentifier of the prequalification.
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.
vendor_idstring (uuid)YesIdentifier of the vendor.
valid_tostring (date) | nullYesExpiry.
scope_notestringYesWhat the vendor is prequalified for.Constraints: length 1 to 20000
decision"Approved" | "Rejected" | nullYesDecision; null while pending.
decided_bystring (uuid) | nullYesIdentifier of the person who decided.
decided_atstring (date-time) | nullYesWhen it was decided.
{
  "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",
  "vendor_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "valid_to": "2026-10-08",
  "scope_note": "Rigging over 2,000 kg.",
  "decision": "Approved",
  "decided_by": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "decided_at": "2026-10-08T14:30:00Z"
}

Code samples

curl -X POST "$XOS_BASE_URL/prequalifications/0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f/decide" \
  -H "Authorization: Bearer $XOS_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{"decision":"Approved","valid_to":"2027-12-31"}'
const { data } = await xos.prequalifications.decide("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", {
    "decision": "Approved",
    "valid_to": "2027-12-31"
  });
response = xos.prequalifications.decide("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", {"decision": "Approved", "valid_to": "2027-12-31"})
xos prequalifications decide 0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f --data '{"decision":"Approved","valid_to":"2027-12-31"}'