customerRequestDataErasure
mutation

Choose a version:

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.

Anchor to section titled 'Arguments'

Arguments

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

Was this section helpful?

Anchor to section titled 'CustomerRequestDataErasurePayload returns'

CustomerRequestDataErasurePayload returns

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

Was this section helpful?

Code examples for MUTATION: customerRequestDataErasure

Query Reference for MUTATION: customerRequestDataErasure

"mutation customerRequestDataErasure($customerId: ID!) {\n  customerRequestDataErasure(customerId: $customerId) {\n    customerId\n    userErrors {\n      field\n      message\n    }\n  }\n}"

Input Reference for MUTATION: customerRequestDataErasure

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

Schema Reference for MUTATION: customerRequestDataErasure

""

Display Examples for MUTATION: customerRequestDataErasure

[]

customerRequestDataErasuremutation

Arguments

CustomerRequestDataErasurePayload returns

customerRequestDataErasure
mutation