Saltar al contenido

Update a prequalification

Módulo Vendors

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.

  • Requiere la capacidad vendors.vendor.write.
  • Alcances de OAuth: vendors.
  • Envía If-Match con el ETag que leíste. Una etiqueta desactualizada devuelve 412; si falta, devuelve 428.
  • Estados de error: 400, 401, 404, 412, 422, 428, 429. Los errores son detalles de problema RFC 9457.

Parámetros de ruta y de consulta

prequalifications.update: Parámetros de ruta y de consulta
CampoTipoObligatorioDescripción
idstring (uuid)SíIdentifier of the prequalification.

Cuerpo de la solicitud: PrequalificationUpdate

prequalifications.update: PrequalificationUpdate
CampoTipoObligatorioDescripción
valid_tostring (date) | nullNoExpiry.
scope_notestringNoWhat the vendor is prequalified for.Restricciones: length 1 to 20000
{
  "valid_to": "2026-10-08",
  "scope_note": "Rigging over 2,000 kg."
}

Respuesta 200: Prequalification

prequalifications.update: Prequalification
CampoTipoObligatorioDescripción
idstring (uuid)SíIdentifier of the prequalification.
org_idstring (uuid)SíIdentifier of the owning organization, derived from the parent row and never accepted from the caller.
created_atstring (date-time)SíWhen the row was created.
created_bystring (uuid) | nullSíIdentifier of the person who created the row; null when a seed, platform or system process created it.
updated_atstring (date-time)SíWhen the row was last updated.
updated_bystring (uuid) | nullSíIdentifier of the person who last updated the row; null when a seed, platform or system process updated it.
vendor_idstring (uuid)SíIdentifier of the vendor.
valid_tostring (date) | nullSíExpiry.
scope_notestringSíWhat the vendor is prequalified for.Restricciones: length 1 to 20000
decision"Approved" | "Rejected" | nullSíDecision; null while pending.
decided_bystring (uuid) | nullSíIdentifier of the person who decided.
decided_atstring (date-time) | nullSí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"
}

Ejemplos de código

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