Appearance
Update a prize
PATCH
/programs/{id}/prizes/{prizeId}
Renames a prize or moves it. Editing the ladder of a program whose cards are already installed is subject to the same edit lock as the program itself — a holder must not watch the reward they were working towards change underneath them.
Authorizations
ApiKeyBearer
A shop-scoped API key created in the dashboard and shown exactly once. An MCP tmk_ key presented here returns a 401 that names the mistake.
Type
HTTP (bearer)
Parameters
Header Parameters
Idempotency-Key
Makes a retry safe: a repeat with the same key and body replays the stored response; the same key with a different body is a 409. Keys are remembered for 24h (IDEMPOTENCY_DEDUPE_WINDOW_HOURS). A request without the header is processed normally.
Type
string
Max Length
255Path Parameters
id*
An opaque id. The API never promises an id format.
Type
Requiredstring
prizeId*
An opaque id. The API never promises an id format.
Type
Requiredstring
Request Body
application/json
JSON "threshold": 10, "name": "Free coffee", "name_localizations": { "it": "Tessera Caffè" }, "description": "One espresso or filter coffee, redeemed at the till.", "description_localizations": { "it": "Dieci caffè, l’undicesimo lo offriamo noi." }, "ordinal": 0
{
}
Responses
Update a prize
application/json
JSON "id": "prz_docsfixture0001", "program_id": "prg_docsfixture0001", "threshold": 10, "name": "Free coffee", "description": "One espresso or filter coffee, redeemed at the till.", "ordinal": 0, "created_at": "2026-08-05T10:15:00.000Z", "updated_at": "2026-09-04T10:15:00.000Z"
{
}
PATCH
/programs/{id}/prizes/{prizeId}