Skip to content

Delete a shortlist entry

Opportunities module

DELETE/shortlists/{id}shortlistEntries.delete

An application placed on the opportunity shortlist. Soft-deletes the shortlist entry: it moves to Trash and can be restored for its table's retention period.

  • Requires the capability opportunities.application.review.
  • OAuth scopes: opportunities.
  • Error statuses: 401, 404, 422, 429. Errors are RFC 9457 problem details.

Path and query parameters

shortlistEntries.delete: Path and query parameters
FieldTypeRequiredDescription
idstring (uuid)YesIdentifier of the shortlist.

Response 204: no body.

Code samples

curl -X DELETE "$XOS_BASE_URL/shortlists/0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f" \
  -H "Authorization: Bearer $XOS_API_KEY"
const { data } = await xos.shortlistEntries.delete("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f");
response = xos.shortlist_entries.delete("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f")
xos shortlist-entries delete 0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f