<- Gift Cards API

Gift Cards API

Unlink customer from gift card

POST

 /v2/gift-cards/{gift_card_id}/unlink-customer

Unlinks a customer from a gift card, which is also referred to as removing a card on file.

Permissions:GIFTCARDS_WRITE

Guide

Manage gift cards on file

Try in API Explorer
Link to section

Path parameters

Example code

Link to section

gift_card_id

string

Required

The ID of the gift card to be unlinked.

Link to section

Request body

Link to section

customer_id

string

Required

The ID of the customer to unlink from the gift card.

Min Length
1
Max Length
191
Link to section

Response fields

Link to section

errors

Any errors that occurred during the request.

Show attributes
Link to section

gift_card

The gift card with the ID of the unlinked customer removed from the customer_ids field. If no other customers are linked, the customer_ids field is also removed.

Show attributes