Extend a gift card

Changes a gift card's expiry date and metadata. Smooth POS finds the card by its serial, not its id, and only expiration and metadata are saved. Everything else in the body, including the balance, customer and amounts, is ignored.

Always send expiration

The expiry is set to whatever you send, so leaving it out clears it. Send the card's current expiry if you only want to change metadata.

Fires the giftcard_update system hook with the card before and after the change.

Required permission:

GroupPermission
CustomersCreate, edit and delete gift cards; manage = issue and extend (includes view)
Body Params
string
required

Serial number of the gift card to extend.

date-time
required

The new expiry date and time (UTC).

metadata
object

Metadata to save on the card.

Responses

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