API reference · Templates

Rename a template

PATCH/v1/templates/{slug}FreeSafe to retry with Idempotency-Key

Changes its name or install page heading. Its design, version and passes stay as they are.

Path

slugstringrequired

The template's slug. org:<slug> for one your organization shares with this workspace (those can only be read).

Body

namestring, up to 80 characters

Its new name.

installHeadlinestring or null, up to 120 characters

The install page's heading for its passes. Null: ours.

Answer

200OK

Errors

Every error has the same shape: see Errors.

Status	Code	When
400	`validation_error`	A field is wrong or unknown.
403	`organization_template`	It's your organization's: change it in the dashboard, or duplicate it to make your own.
404	`not_found`	No template with that slug here.
409	`idempotency_conflict`	The Idempotency-Key was already used for a different request.

Request

curl -X PATCH "https://api.walletpassapi.com/v1/templates/gold-member" \
  -H "Authorization: Bearer $WALLET_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Gold members"
  }'

const res = await fetch("https://api.walletpassapi.com/v1/templates/gold-member", {
  method: "PATCH",
  headers: {
    Authorization: `Bearer ${process.env.WALLET_API_KEY}`,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "name": "Gold members"
  }),
});
const data = await res.json();

import os

import requests

res = requests.patch(
    "https://api.walletpassapi.com/v1/templates/gold-member",
    headers={"Authorization": f"Bearer {os.environ['WALLET_API_KEY']}"},
    json={
        "name": "Gold members",
    },
)
data = res.json()

<?php

$ch = curl_init("https://api.walletpassapi.com/v1/templates/gold-member");
curl_setopt_array($ch, [
    CURLOPT_CUSTOMREQUEST => "PATCH",
    CURLOPT_HTTPHEADER => [
        "Authorization: Bearer " . getenv("WALLET_API_KEY"),
        "Content-Type: application/json",
    ],
    CURLOPT_POSTFIELDS => json_encode([
        "name" => "Gold members",
    ]),
    CURLOPT_RETURNTRANSFER => true,
]);
$data = json_decode(curl_exec($ch), true);

200 OK

{
  "template": {
    "slug": "gold-member",
    "name": "Gold members",
    "design": {
      "organizationName": "Acme Coffee",
      "logoText": "Acme",
      "style": "loyalty",
      "primaryFields": [
        {
          "key": "points",
          "label": "Points",
          "value": "{{points}}",
          "changeMessage": "You now have %@ points"
        }
      ],
      "secondaryFields": [
        {
          "key": "member",
          "label": "Member",
          "value": "{{holder.name}}"
        }
      ],
      "barcodeValue": "{{member_id}}",
      "barcodeFormat": "QR"
    },
    "placeholders": [
      {
        "key": "points",
        "type": "number",
        "required": true
      },
      {
        "key": "member_id",
        "label": "Member ID",
        "type": "text",
        "required": true
      }
    ],
    "keys": [
      "points",
      "holder.name",
      "member_id"
    ],
    "holderRequired": {
      "name": true,
      "email": false
    },
    "issuer": null,
    "installHeadline": null,
    "version": 1,
    "passes": 0,
    "outdated": 0,
    "organization": false,
    "createdAt": "2026-10-08T19:31:12.000Z",
    "updatedAt": "2026-10-08T19:31:12.000Z"
  }
}