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

Copy
mutation {
  shareGiftRegistry(
    giftRegistryUid: ID!
    sender: ShareGiftRegistrySenderInput!
    invitees: [ShareGiftRegistryInviteeInput!]!
  ) {
    ShareGiftRegistryOutput
  }
}
Copied to your clipboard
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.

Example usage

The following example creates a gift registry.

Request:

Copy
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
  }
}
Copied to your clipboard
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:

Copy
{
  "data": {
    "shareGiftRegistry": {
     "is_shared": true
     }
  }
}
Copied to your clipboard
{
  "data": {
    "shareGiftRegistry": {
     "is_shared": true
     }
  }
}

Last updated 9/7/2023

Was this helpful?

Yes

No