removeGiftRegistryRegistrants mutation

The removeGiftRegistryRegistrants mutation removes one or more registrants from the specified gift registry.

This mutation requires a valid customer authentication token.

Syntax

1
2
3
4
5
6
7
8
mutation {
  removeGiftRegistryRegistrants(
    giftRegistryUid: ID!,
    registrantsUid: [ID!]!
  ) {
    RemoveGiftRegistryRegistrantsOutput
  }
}

Example usage

The following example removes a registrant from the specified gift registry.

Request:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
mutation{
  removeGiftRegistryRegistrants(
      giftRegistryUid: "W9YcRai9JmzGglqP3p0USodTTM3BmjjY",
      registrantsUid: "OA=="
    ){
    gift_registry {
      uid
      registrants {
        uid
        firstname
        lastname
        email
      }
    }
  }
}

Response:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
{
  "data": {
    "removeGiftRegistryRegistrants": {
      "gift_registry": {
        "uid": "W9YcRai9JmzGglqP3p0USodTTM3BmjjY",
        "registrants": [
          {
            "uid": "Mg==",
            "firstname": "Stacey",
            "lastname": "Gaines",
            "email": "staceyg@example.com"
          }
        ]
      }
    }
  }
}

Input attributes

The removeGiftRegistryRegistrants mutation requires the following input.

Output attributes

The RemoveGiftRegistryRegistrantsOutput 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: