giftCardSendNotificationToRecipient

mutation

Requires write_gift_cards access scope.

Send notification to the recipient of a gift card.

Arguments

Anchor to idid • ID!required: The ID of the gift card to send.

Was this section helpful?

Anchor to GiftCardSendNotificationToRecipientPayload returnsGiftCardSendNotificationToRecipientPayload returns

Anchor to giftCardgiftCard • GiftCard: The gift card that was sent.
Anchor to userErrorsuserErrors • [GiftCardSendNotificationToRecipientUserError!]!non-null: The list of errors that occurred from executing the mutation.

Was this section helpful?

Send a notification to a gift card's recipient
giftCardSendNotificationToRecipient reference

Examples

1const { admin } = await authenticate.admin(request);
2
3const response = await admin.graphql(
4  `#graphql
5  mutation giftCardSendNotificationToRecipient($id: ID!) {
6    giftCardSendNotificationToRecipient(id: $id) {
7      giftCard {
8        id
9        recipientAttributes {
10          recipient {
11            id
12          }
13        }
14      }
15      userErrors {
16        message
17        field
18        code
19      }
20    }
21  }`,
22  {
23    variables: {
24      "id": "gid://shopify/GiftCard/698360200"
25    },
26  },
27);
28
29const data = await response.json();
30

mutation giftCardSendNotificationToRecipient($id: ID!) {
  giftCardSendNotificationToRecipient(id: $id) {
    giftCard {
      id
      recipientAttributes {
        recipient {
          id
        }
      }
    }
    userErrors {
      message
      field
      code
    }
  }
}

curl -X POST \
https://your-development-store.myshopify.com/admin/api/2025-04/graphql.json \
-H 'Content-Type: application/json' \
-H 'X-Shopify-Access-Token: {access_token}' \
-d '{
"query": "mutation giftCardSendNotificationToRecipient($id: ID!) { giftCardSendNotificationToRecipient(id: $id) { giftCard { id recipientAttributes { recipient { id } } } userErrors { message field code } } }",
 "variables": {
    "id": "gid://shopify/GiftCard/698360200"
  }
}'

const { admin } = await authenticate.admin(request);

const response = await admin.graphql(
  `#graphql
  mutation giftCardSendNotificationToRecipient($id: ID!) {
    giftCardSendNotificationToRecipient(id: $id) {
      giftCard {
        id
        recipientAttributes {
          recipient {
            id
          }
        }
      }
      userErrors {
        message
        field
        code
      }
    }
  }`,
  {
    variables: {
      "id": "gid://shopify/GiftCard/698360200"
    },
  },
);

const data = await response.json();

const client = new shopify.clients.Graphql({session});
const data = await client.query({
  data: {
    "query": `mutation giftCardSendNotificationToRecipient($id: ID!) {
      giftCardSendNotificationToRecipient(id: $id) {
        giftCard {
          id
          recipientAttributes {
            recipient {
              id
            }
          }
        }
        userErrors {
          message
          field
          code
        }
      }
    }`,
    "variables": {
      "id": "gid://shopify/GiftCard/698360200"
    },
  },
});

session = ShopifyAPI::Auth::Session.new(
  shop: "your-development-store.myshopify.com",
  access_token: access_token
)
client = ShopifyAPI::Clients::Graphql::Admin.new(
  session: session
)

query = <<~QUERY
  mutation giftCardSendNotificationToRecipient($id: ID!) {
    giftCardSendNotificationToRecipient(id: $id) {
      giftCard {
        id
        recipientAttributes {
          recipient {
            id
          }
        }
      }
      userErrors {
        message
        field
        code
      }
    }
  }
QUERY

variables = {
  "id": "gid://shopify/GiftCard/698360200"
}

response = client.query(query: query, variables: variables)

Input variables

JSON

1{
2  "id": "gid://shopify/GiftCard/698360200"
3}

Response

JSON

1{
2  "giftCardSendNotificationToRecipient": {
3    "giftCard": {
4      "id": "gid://shopify/GiftCard/698360200",
5      "recipientAttributes": {
6        "recipient": {
7          "id": "gid://shopify/Customer/105906728"
8        }
9      }
10    },
11    "userErrors": []
12  }
13}