Skip to content
XOS Developers

Delete a sponsor entitlement

Vendors module

DELETE/sponsor-entitlements/{id}sponsorEntitlements.delete

A sponsor entitlement with fulfillment tracking. Soft-deletes the sponsor entitlement: it moves to Trash and can be restored for its table's retention period.

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

Path and query parameters

sponsorEntitlements.delete: Path and query parameters
FieldTypeRequiredDescription
idstring (uuid)YesIdentifier of the sponsor entitlement.

Response 204: no body.

Code samples

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