Update Gift Card

Replaces a gift card's number, amount, remarks and expiry (all values are overwritten with what is sent — omitted optional fields are cleared). Changing the number to one that already exists is rejected. Requires the p/c-gift-cards permission.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
integer
required

Gift card id (from the gift cards list).

Body Params
string
required
length ≤ 100

Unique card number (letters, numbers, dashes, underscores).

number
required

Card value; must be greater than 0.

string | null
string | null

Expiry date (e.g. 2027-12-31), interpreted in the company timezone; cannot be in the past.

Headers
string
required

The merchant install this request acts on (install.store_id from the app.installed webhook).

Response

Language
Credentials
Bearer
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json