v1

latestOpenAPI 3.0.1MIT2026-07-263151,3912.3 MB

Loyalties

Delete Loyalty Campaign

Deletes a loyalty campaign and all related loyalty cards. This action cannot be undone. Also, it immediately removes any redemptions on loyalty cards.

If the force parameter is set to false or not set at all, the loyalty campaign and all related loyalty cards will be moved to the bin.

delete/v1/loyalties/{campaignId}

Query parameters

forceboolean

If this flag is set to true, the campaign and related vouchers will be removed permanently. If it is set to false or not set at all, the loyalty campaign and all related loyalty cards will be moved to the bin. Going forward, the user will be able to create the next campaign with the same name.

Response

Returns the ID of the scheduled asynchronous action, informing you that your request has been accepted and the loyalty campaign will be deleted from the repository asynchronously. To check the deletion status and result, copy the async_action_id from the response and pass it using Get Async Action endpoint.

async_action_idstring required

The ID of the scheduled asynchronous action.

Example response

{
  "async_action_id": "aa_0a875d56c805df6601"
}