Update a prequalification
Vendors module
PATCH/prequalifications/{id}prequalifications.update
A vendor prequalification. Updates the fields sent; omitted fields are unchanged. Requires `If-Match` with the current `ETag`: a stale tag returns 412 and a missing tag returns 428.
- Requires the capability vendors.vendor.write.
- OAuth scopes: vendors.
- Send If-Match with the ETag you read. A stale tag returns 412; a missing tag returns 428.
- Error statuses: 400, 401, 404, 412, 422, 428, 429. Errors are RFC 9457 problem details.
Path and query parameters
| Field | Type | Required | Description |
|---|---|---|---|
| id | string (uuid) | Yes | Identifier of the prequalification. |
Request body: PrequalificationUpdate
| Field | Type | Required | Description |
|---|---|---|---|
| valid_to | string (date) | null | No | Expiry. |
| scope_note | string | No | What the vendor is prequalified for.Constraints: length 1 to 20000 |
{
"valid_to": "2026-10-08",
"scope_note": "Rigging over 2,000 kg."
}Response 200: Prequalification
| Field | Type | Required | Description |
|---|---|---|---|
| id | string (uuid) | Yes | Identifier of the prequalification. |
| 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. |
| vendor_id | string (uuid) | Yes | Identifier of the vendor. |
| valid_to | string (date) | null | Yes | Expiry. |
| scope_note | string | Yes | What the vendor is prequalified for.Constraints: length 1 to 20000 |
| decision | "Approved" | "Rejected" | null | Yes | Decision; null while pending. |
| decided_by | string (uuid) | null | Yes | Identifier of the person who decided. |
| decided_at | string (date-time) | null | Yes | When 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 PATCH "$XOS_BASE_URL/prequalifications/0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f" \
-H "Authorization: Bearer $XOS_API_KEY" \
-H 'If-Match: W/"etag-from-your-last-read"' \
-H "Content-Type: application/json" \
-d '{"valid_to":"2026-10-08","scope_note":"Rigging over 2,000 kg."}'const { data, etag } = await xos.prequalifications.update("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", {
"valid_to": "2026-10-08",
"scope_note": "Rigging over 2,000 kg."
}, { ifMatch: etag });response = xos.prequalifications.update("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", {"valid_to": "2026-10-08", "scope_note": "Rigging over 2,000 kg."}, if_match=etag)xos prequalifications update 0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f --data '{"valid_to":"2026-10-08","scope_note":"Rigging over 2,000 kg."}' --if-match auto