REST API

Google Wallet designs

Google Wallet pass designs — the templates applied to generated Google Wallet passes.

A Google Wallet design defines the visual design applied when generating Google Wallet passes. Designs are reusable across events. Each company has one company-default Google Wallet design; individual events may override it.

Note: Google Wallet designs are assignable only at the event or company-default level — there is no ticket-type rung. As a result, the shared_ticket_type blocker never applies to Google Wallet designs.

Default response fields

id, created_at, updated_at, name, archived, default.

archived is true when the design has been archived. Archived designs remain attached to past events but are excluded from the active design list by default.

List Google Wallet designs

GET /google_wallet_designs

Request parameters

Parameter Type Description
page[cursor] string Opaque cursor token. Send empty for first page. See Pagination.
page[size] integer Records per page. Default 10, maximum 100.
sort[{field}] string Sort by id, created_at, updated_at, name. Value is asc or desc.
filter[search] string Search Google Wallet designs by name (case-insensitive substring match).
filter[archived] boolean Pass true to list archived Google Wallet designs instead of active ones. Defaults to active only.

Get Google Wallet design

GET /google_wallet_designs/{id}

Create Google Wallet design

POST /google_wallet_designs

Request parameters

Parameter Type Description
google_wallet_design[name] string Required. Design name.

Update Google Wallet design

PATCH /google_wallet_designs/{id}

Same parameter shape as create. Pass only the fields you want to change.

Delete Google Wallet design

DELETE /google_wallet_designs/{id}

Permanently deletes the Google Wallet design. Returns 204 No Content. Designs pinned to active events cannot be deleted — archive them first.

Archive Google Wallet design

PATCH /google_wallet_designs/{id}/archive

Archives the Google Wallet design. Archived designs are excluded from GET /google_wallet_designs by default; pass filter[archived]=true to include them. If the design is the company default, is referenced by an entitlement pass definition, or there is no default to fall back to, the request returns 422 with errors.blockers (one or more of is_default, in_use_by_definitions, no_default). Note: the shared_ticket_type blocker does not apply to Google Wallet designs (no ticket-type assignment rung). Otherwise active events using it are reset to the company default and past events are left unchanged.

Restore Google Wallet design

PATCH /google_wallet_designs/{id}/restore

Restores a previously archived Google Wallet design. Does not re-attach events that were reset to the default during archive.

Archive preview Google Wallet design

GET /google_wallet_designs/{id}/archive_preview

Returns whether the Google Wallet design can be archived and the impact, without changing anything: { archivable, blockers, active_events: [{ id, name }], active_events_count, past_events_count }.

List overrides

GET /google_wallet_designs/overrides

Lists active events that override the company default Google Wallet design (per-event assignment): { data: [{ event: { id, name }, design: { id, name } }] }.