updateGiftRegistry mutation

The updateGiftRegistry mutation modifies properties of specified gift registry. It does not update the items in a gift registry or registrants. Use the updateGiftRegistryItems or updateGiftRegistryRegistrants mutation to modify gift registry items or registrants.

This mutation requires a valid customer authentication token.

Syntax

1
2
3
4
5
6
7
8
mutation {
  updateGiftRegistry(
    giftRegistryUid: ID!
    giftRegistry: UpdateGiftRegistryInput!
  ) {
    UpdateGiftRegistryOutput
  }
}

Example usage

The following example changes the privacy, the message, and the event date for a gift registry.

Request:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
mutation{
  updateGiftRegistry(
    giftRegistryUid: "D0R6d2B7aZWOQuuWftHZ0iwuexQPgaei",
    giftRegistry: {
      privacy_settings: PUBLIC
      message: "Help us celebrate Bill and Julie's wedding, which will be held on May 8, 2021"
      dynamic_attributes: {
        code: "event_date"
        value: "2021-05-08"
      }
    })
  {
    gift_registry {
      uid
      event_name
      message
      status
      privacy_settings
      dynamic_attributes {
        code
        label
        value
      }
    }
  }
}

Response:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
{
  "data": {
    "updateGiftRegistry": {
      "gift_registry": {
        "uid": "D0R6d2B7aZWOQuuWftHZ0iwuexQPgaei",
        "event_name": "Bill and Julie's wedding",
        "message": "Help us celebrate Bill and Julie's wedding, which will be held on May 8, 2021",
        "status": "ACTIVE",
        "privacy_settings": "PUBLIC",
        "dynamic_attributes": [
          {
            "code": "event_country",
            "label": "Country",
            "value": "US"
          },
          {
            "code": "event_date",
            "label": "Wedding Date",
            "value": "2021-05-08"
          },
          {
            "code": "event_location",
            "label": "Location",
            "value": "Ann Arbor, MI"
          },
          {
            "code": "number_of_guests",
            "label": "Number of Guests",
            "value": "101"
          }
        ]
      }
    }
  }
}

Input attributes

The updateGiftRegistry mutation requires the following input objects.

UpdateGiftRegistryInput attributes

The UpdateGiftRegistryInput object contains the following attributes:

GiftRegistryDynamicAttributeInput attributes

The GiftRegistryDynamicAttributeInput object contains the following attributes:

GiftRegistryShippingAddressInput attributes

The GiftRegistryShippingAddressInput object contains the following attributes:

CustomerAddressInput attributes

CustomerAddressInput attributes

The CustomerAddressInput object can contain the following attributes:

CustomerAddressAttributeInput attributes

The CustomerAddressAttributeInput data type has been deprecated because the contents are not applicable for GraphQL. It can contain the following attributes:

CustomerAddressRegionInput attributes

The customerAddressRegionInput object can contain the following attributes:

Output attributes

The UpdateGiftRegistryOutput output object contains the following attribute:

GiftRegistry attributes

The GiftRegistry object returns the following attributes:

GiftRegistryDynamicAttribute attributes

The GiftRegistryDynamicAttribute object implements GiftRegistryDynamicAttributeInterface. It also defines the following attribute.

GiftRegistryDynamicAttributeInterface attributes

The GiftRegistryDynamicAttribute and GiftRegistryRegistrantDynamicAttribute data types implement the GiftRegistryDynamicAttributeInterface.

This interface contains the following attributes:

GiftRegistryDynamicAttributeMetadataInterface

The GiftRegistryDynamicAttributeMetadata data type implements the GiftRegistryDynamicAttributeMetadataInterface.

This interface contains the following attributes:

GiftRegistryItemInterface attributes

This GiftRegistryItemInterface contains the following attributes:

GiftRegistryRegistrant attributes

The GiftRegistryRegistrant object contains the following attributes:

GiftRegistryRegistrantDynamicAttribute attributes

The GiftRegistryRegistrantDynamicAttribute data type implements the GiftRegistryDynamicAttributeInterface. It does not introduce any additional attributes.

GiftRegistryType attributes

The GiftRegistryType object contains the following attributes: