Skip to content
XOS Developers

Delete a loyalty program

Identity module

DELETE/loyalty-programs/{id}loyaltyPrograms.delete

A travel loyalty program the caller belongs to, at most twenty (422 loyalty_program_limit). A program name appears once per kind (409). Shared with an engagement under the Travel Profile category. Soft-deletes the loyalty program: it moves to Trash and can be restored for its table's retention period.

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

Path and query parameters

loyaltyPrograms.delete: Path and query parameters
FieldTypeRequiredDescription
idstring (uuid)YesIdentifier of the loyalty program.

Response 204: no body.

Code samples

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