Create a shortlist entry

Opportunities module

POST/shortlistsshortlistEntries.create

An application placed on the opportunity shortlist. Creates a shortlist entry. Requires `Idempotency-Key`; a replay returns the original response. The organization is derived from the credential or the parent row, never from the body.

Requires the capability opportunities.application.review.
OAuth scopes: opportunities.
Send an Idempotency-Key header. A replay with the same key returns the original response.
Error statuses: 400, 401, 409, 422, 429. Errors are RFC 9457 problem details.

Request body: ShortlistCreate

shortlistEntries.create: ShortlistCreate
Field	Type	Required	Description
opportunity_id	string (uuid)	Yes	Identifier of the opportunity.
application_id	string (uuid)	Yes	Identifier of the application.
rank	integer \| null	No	Rank on the shortlist.Constraints: range 1 to any

{
  "opportunity_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "application_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "rank": 1
}

Response 201: Shortlist

shortlistEntries.create: 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 POST "$XOS_BASE_URL/shortlists" \
  -H "Authorization: Bearer $XOS_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{"opportunity_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f","application_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f","rank":1}'

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

response = xos.shortlist_entries.create({"opportunity_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", "application_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", "rank": 1})

xos shortlist-entries create --data '{"opportunity_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f","application_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f","rank":1}'