Link Customer To Gift Card - Automate.ax

square.linkCustomerToGiftCard links a customer to a gift card, which is also referred to as adding a card on file.

Example

automations/square-link-customer-to-gift-card.automation.ts

import { automation, onDashboardRun } from "automate.ax"
import { square } from "automate.ax/square"

export default automation("Link Square Customer To Gift Card", () => {
  onDashboardRun({ title: "Link Square Customer To Gift Card" })

  square.linkCustomerToGiftCard({
    giftCardId: "gift_card_id",
    customerId: "GKY0FZ3V717AH8Q2D821PNT2ZW",
  })
})

Inputs

Every input accepts a compatible signal. It requires GIFTCARDS_WRITE.

Field	Type	Required	Default	Description
`giftCardId`	`string`	Yes	—	The ID of the gift card to be linked.
`customerId`	`string`	Yes	—	The ID of the customer to link to the gift card.

Use the official LinkCustomerToGiftCard reference for provider field semantics and limits.

Output

Returns the official Square.LinkCustomerToGiftCardResponse response as a codec-safe object. Square integer money amounts remain bigint values.