Update a shortlist entry

Módulo Opportunities

PATCH/shortlists/{id}shortlistEntries.update

An application placed on the opportunity shortlist. 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 opportunities.application.review.
Alcances de OAuth: opportunities.
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

shortlistEntries.update: Parámetros de ruta y de consulta
Campo	Tipo	Obligatorio	Descripción
id	string (uuid)	Sí	Identifier of the shortlist.

Cuerpo de la solicitud: ShortlistUpdate

shortlistEntries.update: ShortlistUpdate
Campo	Tipo	Obligatorio	Descripción
rank	integer \| null	No	Rank on the shortlist.Restricciones: range 1 to any

{
  "rank": 1
}

Respuesta 200: Shortlist

shortlistEntries.update: Shortlist
Campo	Tipo	Obligatorio	Descripción
id	string (uuid)	Sí	Identifier of the shortlist.
org_id	string (uuid)	Sí	Identifier of the owning organization, derived from the parent row and never accepted from the caller.
created_at	string (date-time)	Sí	When the row was created.
created_by	string (uuid) \| null	Sí	Identifier of the person who created the row; null when a seed, platform or system process created it.
updated_at	string (date-time)	Sí	When the row was last updated.
updated_by	string (uuid) \| null	Sí	Identifier of the person who last updated the row; null when a seed, platform or system process updated it.
opportunity_id	string (uuid)	Sí	Identifier of the opportunity.
application_id	string (uuid)	Sí	Identifier of the application.
rank	integer \| null	Sí	Rank on the shortlist.Restricciones: range 1 to any

{
  "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",
  "opportunity_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "application_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "rank": 1
}

Ejemplos de código

curl -X PATCH "$XOS_BASE_URL/shortlists/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 '{"rank":1}'

const { data, etag } = await xos.shortlistEntries.update("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", {
    "rank": 1
  }, { ifMatch: etag });

response = xos.shortlist_entries.update("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", {"rank": 1}, if_match=etag)

xos shortlist-entries update 0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f --data '{"rank":1}' --if-match auto