data-src=../../../../includes/commerce-only.md

shareGiftRegistry mutation

The shareGiftRegistry mutation sends an invitation to a list email addresses to shop from the customer's gift registry.

This mutation requires a valid customer authentication token.

Syntax

mutation {
  shareGiftRegistry(
    giftRegistryUid: ID!
    sender: ShareGiftRegistrySenderInput!
    invitees: [ShareGiftRegistryInviteeInput!]!
  ) {
    ShareGiftRegistryOutput
  }
}

Reference

The shareGiftRegistry reference provides detailed information about the types and fields defined in this mutation.

• Adobe Commerce as a Cloud Service

• On-Premises/Cloud

Example usage

The following example creates a gift registry.

Request:

mutation{
  shareGiftRegistry(
    giftRegistryUid: "W9YcRai9JmzGglqP3p0USodTTM3BmjjY",
    sender: {
      name: "Roni Costello"
      message: "Help us celebrate Theo's 45th Birthday"
    }
    invitees: [
      {
        name: "Brenda Vazquez"
        email: "brenda@example.com"
      }
      {
        name: "Alex Brunner"
        email: "alex1@example.com"
      }
    ]){
    is_shared
  }
}

Response:

{
  "data": {
    "shareGiftRegistry": {
     "is_shared": true
     }
  }
}

data-slots=text

data-backgroundcolor=gray