Delete Dynamic Pass Template API

Overview

Soft-deletes a dynamic pass template and schedules deletion of every wallet pass that was issued from it. This is a cascading operation — both the template and all of its passes are removed.

⚠️ Cascading deletion

Deleting a template removes every pass created from it. Apple and Google Wallet passes are queued for removal in the background — customers will see the passes disappear from their wallets as the batch processes. This action is not reversible via the API.

Base URL

https://app.addtowallet.co

DELETE/api/v2/dynamicPass/template/:templateId

Path Parameters

templateId (string, required): ThedynamicPassId of the template to delete.

Authentication

All API requests must include your API key in the request headers:

"apikey": "your-api-key-here"

Request Example

curl -X DELETE 'https://app.addtowallet.co/api/v2/dynamicPass/template/686d0d92c2f0bc5cdf25c834' \
  -H 'apikey: your-api-key-here'

Response

The template is soft-deleted synchronously. Pass deletion is queued and a batchId is returned for tracking.

Success Response Fields

message (string): "Passes scheduled for deletion".
batchId (string | null): Tracks the queued pass-deletion job. null when no passes existed for this template. Poll Batch Status to confirm completion.

Response Example

{
  "message": "Passes scheduled for deletion",
  "batchId": "686d111dab9ab557fe3e5644"
}

What gets removed

• The template document is marked deleted (it will no longer appear in List Templates).
• Every wallet pass issued from this template is queued for deletion and removed from Apple / Google Wallet asynchronously.
• Customer records in the associated user group are not deleted — they remain in Manage Users with their hasPass flag flipped to false as their passes are removed.
• Loyalty templates are deleted exactly the same way — the stamp / points passes issued from them are queued for removal too.

Error Code	Description
401	Unauthorized - Missing or invalid API key.
404	Not Found - Template with the specified ID does not exist or is already deleted.
429	Too Many Requests - API rate limit exceeded. Please wait before making additional requests.
500	Internal Server Error - Unexpected error scheduling template deletion. Please contact support.