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 |