Update a shortlist entry
Opportunities module
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.
- Requires the capability opportunities.application.review.
- OAuth scopes: opportunities.
- 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 shortlist. |
Request body: ShortlistUpdate
| Field | Type | Required | Description |
|---|---|---|---|
| rank | integer | null | No | Rank on the shortlist.Constraints: range 1 to any |
{
"rank": 1
}Response 200: Shortlist
| Field | Type | Required | Description |
|---|---|---|---|
| id | string (uuid) | Yes | Identifier of the shortlist. |
| 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. |
| opportunity_id | string (uuid) | Yes | Identifier of the opportunity. |
| application_id | string (uuid) | Yes | Identifier of the application. |
| rank | integer | null | Yes | Rank on the shortlist.Constraints: 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
}Code samples
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