API reference · Broadcasts

Preview a broadcast

POST/v1/broadcasts/previewFree

How many passes a broadcast would reach, on which phones, and whether this month's operations cover it. Sends nothing.

Body

filtersobject

Which passes: the same search and filters as List passes, such as { "q": "gold", "appleInstalled": "true" }. Left out or empty, every active pass. An unknown filter is refused, so a typo can't reach everyone.

Answer

200OK

total active passes match, at one operation each. blocked says why it can't be sent as it stands, or is null. platform covers the test passes among them, which have their own monthly limit.

Errors

Every error has the same shape: see Errors.

Status	Code	When
400	`validation_error`	A filter isn't valid, or isn't one.
422	`unknown_issuer`	No issuer with that slug here.

Request

curl "https://api.walletpassapi.com/v1/broadcasts/preview" \
  -H "Authorization: Bearer $WALLET_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "filters": {
      "status": "active",
      "template": "gold-member"
    }
  }'

const res = await fetch("https://api.walletpassapi.com/v1/broadcasts/preview", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.WALLET_API_KEY}`,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "filters": {
      "status": "active",
      "template": "gold-member"
    }
  }),
});
const data = await res.json();

import os

import requests

res = requests.post(
    "https://api.walletpassapi.com/v1/broadcasts/preview",
    headers={"Authorization": f"Bearer {os.environ['WALLET_API_KEY']}"},
    json={
        "filters": {
            "status": "active",
            "template": "gold-member",
        },
    },
)
data = res.json()

<?php

$ch = curl_init("https://api.walletpassapi.com/v1/broadcasts/preview");
curl_setopt_array($ch, [
    CURLOPT_CUSTOMREQUEST => "POST",
    CURLOPT_HTTPHEADER => [
        "Authorization: Bearer " . getenv("WALLET_API_KEY"),
        "Content-Type: application/json",
    ],
    CURLOPT_POSTFIELDS => json_encode([
        "filters" => [
            "status" => "active",
            "template" => "gold-member",
        ],
    ]),
    CURLOPT_RETURNTRANSFER => true,
]);
$data = json_decode(curl_exec($ch), true);

200 OK

{
  "total": 1200,
  "appleInstalled": 840,
  "googleSaved": 310,
  "noPhones": 120,
  "operations": {
    "scope": "organization",
    "used": 18342,
    "allowance": 100000,
    "remaining": 81658
  },
  "platform": {
    "passes": 0,
    "used": 0,
    "allowance": 1000,
    "remaining": 1000
  },
  "blocked": null
}