<- Gift Cards API

Gift Cards API

All versions ->

Link customer to gift card

POST

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

Links a customer to a gift card, which is also referred to as adding 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 linked.

Link to section

Request body

Link to section

customer_id

string

Required

The ID of the customer to link to 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.

Link to section

gift_card

The gift card with the ID of the linked customer listed in the customer_ids field.