Skip to content

Delete an opportunity

Opportunities module

DELETE/opportunities/{id}opportunities.delete

An opportunity published from an approved requisition. Without posted compensation it shows Rate on Request, never zero. Soft-deletes the opportunity: it moves to Trash and can be restored for its table's retention period.

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

Path and query parameters

opportunities.delete: Path and query parameters
FieldTypeRequiredDescription
idstring (uuid)YesIdentifier of the opportunity.

Response 204: no body.

Code samples

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