Skip to content

Batch delete draft promo code definitions

Request

Permanently delete up to 50 draft promo codes in one request.

You can only delete draft definitions. For live definitions, use the status-update endpoint to archive them first.

You will see a list of items that could not be deleted, such as missing IDs, duplicates, or non-draft definition, so you can identify what needs attention.

Security
ZephrHmacHttp
Bodyapplication/jsonrequired
definition_idsArray of strings, [ 1 .. 50 ] itemsrequired

The IDs of the promo codes to delete. You can delete 1 to 50 codes, and only draft codes will be removed.

Example:
[ "pd-1", "pd-2" ]
{ "definition_ids": [ "pd-1", "pd-2" ] }

Responses

OK. Your batch was processed. Review which items need attention.

Headers
any
Bodyapplication/json
messagestringrequired

Human-readable summary of the batch result.

Example:"2 promo code definitions created successfully"
failuresArray of objects(promo-code-definition-batch-item-failure)required

Details about why each item failed. Items not listed here were processed successfully.

Response
{ "message": "2 promo codes have been deleted successfully.", "failures": [] }