A PDF design defines the visual design applied when generating ticket PDFs. Designs are reusable across events and ticket types. Each company has one company-default PDF design; individual events or ticket types may override it.
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 PDF designs
GET /pdf_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 PDF designs by name (case-insensitive substring match). |
filter[archived] |
boolean |
Pass true to list archived PDF designs instead of active ones. Defaults to active only. |
Get PDF design
GET /pdf_designs/{id}
Create PDF design
POST /pdf_designs
Request parameters
| Parameter | Type | Description |
|---|---|---|
pdf_design[name] |
string |
Required. Design name. |
Update PDF design
PATCH /pdf_designs/{id}
Same parameter shape as create. Pass only the fields you want to change.
Delete PDF design
DELETE /pdf_designs/{id}
Permanently deletes the PDF design. Returns 204 No Content. Designs pinned to active events cannot be deleted — archive them first.
Archive PDF design
PATCH /pdf_designs/{id}/archive
Archives the PDF design. Archived designs are excluded from GET /pdf_designs by default; pass filter[archived]=true to include them. If the design is the company default, is pinned to a ticket type used by active events, 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, shared_ticket_type, in_use_by_definitions, no_default). Otherwise active events using it are reset to the company default and past events are left unchanged.
Restore PDF design
PATCH /pdf_designs/{id}/restore
Restores a previously archived PDF design. Does not re-attach events that were reset to the default during archive.
Archive preview PDF design
GET /pdf_designs/{id}/archive_preview
Returns whether the PDF 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 /pdf_designs/overrides
Lists active events that override the company default PDF design (per-event assignment): { data: [{ event: { id, name }, design: { id, name } }] }.