Posters

Manage QR code signup posters

Posters are printable QR code signup sheets that customers scan to join your loyalty program. Each poster is tied to a loyalty card and generates a unique public signup URL. Posters can be customized with colors, titles, and paper sizes to match your store branding.

index

GET /api/v1/accounts/:account_id/posters

List posters

Returns all posters for the store. Optionally filter by card or active status.

Parameters

Name	Type	Required	Description
`account_id`	Must be a number.	Required	Store (account) ID
`card_id`	Must be a number.	Optional	Filter posters belonging to a specific card
`active`	Must be a String	Optional	When present, return only active posters

Error Codes

Code	Description
`401`	Unauthorized – invalid or missing API token
`404`	Store not found

show

GET /api/v1/accounts/:account_id/posters/:id

Show a poster

Returns a single poster by ID, including generated signup and display URLs.

Parameters

Name	Type	Required	Description
`account_id`	Must be a number.	Required	Store (account) ID
`id`	Must be a number.	Required	Poster ID

Error Codes

Code	Description
`401`	Unauthorized – invalid or missing API token
`404`	Store or poster not found

create

POST /api/v1/accounts/:account_id/posters

Create a poster

Creates a new printable QR code poster for customer signup. The poster will automatically generate a unique public signup URL and QR code. The card_id is required on create to associate the poster with a loyalty card.

Parameters

Name	Type	Required	Description
`account_id`	Must be a number.	Required	Store (account) ID
`poster`	Must be a Hash	Required	Poster attributes
`poster[card_id]`	Must be a number.	Required	ID of the loyalty card this poster links to
`poster[title]`	Must be a String	Optional	Headline text displayed on the poster
`poster[paper_size]`	Must be a String	Optional	Print size – one of: a4, a5, a6, letter
`poster[primary_color]`	Must be a String	Optional	Primary brand color as a hex string (e.g. ‘#FF5733’)
`poster[secondary_color]`	Must be a String	Optional	Secondary brand color as a hex string
`poster[text_color]`	Must be a String	Optional	Text color as a hex string
`poster[active]`	Must be one of: `true`, `false`, `1`, `0`.	Optional	Whether the poster is active (defaults to true)

Error Codes

Code	Description
`401`	Unauthorized – invalid or missing API token
`404`	Store not found
`422`	Validation failed – check `errors` for details

update

PATCH /api/v1/accounts/:account_id/posters/:id

Update a poster

Updates an existing poster. The card_id cannot be changed after creation.

Parameters

Name	Type	Required	Description
`account_id`	Must be a number.	Required	Store (account) ID
`id`	Must be a number.	Required	Poster ID
`poster`	Must be a Hash	Required	Poster attributes to update
`poster[title]`	Must be a String	Optional	Headline text displayed on the poster
`poster[paper_size]`	Must be a String	Optional	Print size – one of: a4, a5, a6, letter
`poster[primary_color]`	Must be a String	Optional	Primary brand color as a hex string
`poster[secondary_color]`	Must be a String	Optional	Secondary brand color as a hex string
`poster[text_color]`	Must be a String	Optional	Text color as a hex string
`poster[active]`	Must be one of: `true`, `false`, `1`, `0`.	Optional	Whether the poster is active

Error Codes

Code	Description
`401`	Unauthorized – invalid or missing API token
`404`	Store or poster not found
`422`	Validation failed – check `errors` for details

destroy

DELETE /api/v1/accounts/:account_id/posters/:id

Delete a poster

Permanently deletes a poster. The public signup URL will stop working.

Parameters

Name	Type	Required	Description
`account_id`	Must be a number.	Required	Store (account) ID
`id`	Must be a number.	Required	Poster ID

Error Codes

Code	Description
`401`	Unauthorized – invalid or missing API token
`404`	Store or poster not found
`422`	Poster could not be deleted