API reference · Passes

Revoke a pass

DELETE/v1/passes/{serial}FreeSafe to retry with Idempotency-Key

Voids it on holders' phones for good: it can't be scanned, updated or installed again.

Path

serialstringrequired

The pass's serialNumber.

Answer

200Revoked

Revoking it again answers alreadyDeleted: true and changes nothing.

Errors

Every error has the same shape: see Errors.

Status	Code	When
404	`not_found`	No pass with that serial number in this workspace.
409	`idempotency_conflict`	The Idempotency-Key was already used for a different request.

There's no undo: a phone keeps a voided pass voided. To issue it again, create a new pass.
A revoked pass is deleted for good 30 days later.

Request

curl -X DELETE "https://api.walletpassapi.com/v1/passes/9f904677-e06d-4b0f-8404-878ff1066f88" \
  -H "Authorization: Bearer $WALLET_API_KEY"

const res = await fetch("https://api.walletpassapi.com/v1/passes/9f904677-e06d-4b0f-8404-878ff1066f88", {
  method: "DELETE",
  headers: {
    Authorization: `Bearer ${process.env.WALLET_API_KEY}`,
  },
});
const data = await res.json();

import os

import requests

res = requests.delete(
    "https://api.walletpassapi.com/v1/passes/9f904677-e06d-4b0f-8404-878ff1066f88",
    headers={"Authorization": f"Bearer {os.environ['WALLET_API_KEY']}"},
)
data = res.json()

<?php

$ch = curl_init("https://api.walletpassapi.com/v1/passes/9f904677-e06d-4b0f-8404-878ff1066f88");
curl_setopt_array($ch, [
    CURLOPT_CUSTOMREQUEST => "DELETE",
    CURLOPT_HTTPHEADER => [
        "Authorization: Bearer " . getenv("WALLET_API_KEY"),
    ],
    CURLOPT_RETURNTRANSFER => true,
]);
$data = json_decode(curl_exec($ch), true);

200 Revoked

{
  "serialNumber": "9f904677-e06d-4b0f-8404-878ff1066f88",
  "revoked": true,
  "alreadyDeleted": false,
  "notifiedDevices": 1,
  "platforms": {
    "apple": "queued",
    "google": "queued"
  }
}