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