customerRequestDataErasure

mutation

Requires write_customer_data_erasure access scope.

Enqueues a request to erase customer's data. Read more here.

To cancel the data erasure request use the customerCancelDataErasure mutation.

Arguments

Anchor to customerIdcustomerId • ID!required: The ID of the customer to erase.

Was this section helpful?

Anchor to CustomerRequestDataErasurePayload returnsCustomerRequestDataErasurePayload returns

Anchor to customerIdcustomerId • ID: The ID of the customer that will be erased.
Anchor to userErrorsuserErrors • [CustomerRequestDataErasureUserError!]!non-null: The list of errors that occurred from executing the mutation.

Was this section helpful?

Mutation Reference

1mutation customerRequestDataErasure($customerId: ID!) {
2  customerRequestDataErasure(customerId: $customerId) {
3    customerId
4    userErrors {
5      field
6      message
7    }
8  }
9}

Input

1{
2  "customerId": "gid://shopify/<objectName>/10079785100"
3}

{
  "customerId": "gid://shopify/<objectName>/10079785100"
}