Anchor to section titled 'undefined'

dataSaleOptOut
mutation

Requires write_privacy_settings access scope.

Opt out a customer from data sale.

Anchor to section titled 'Arguments'

Arguments

Anchor to email
email
String!
required

The email address of the customer to opt out of data sale.

Was this section helpful?
Anchor to section titled 'DataSaleOptOutPayload returns'

DataSaleOptOutPayload returns

Anchor to DataSaleOptOutPayload.customerId
customerId
ID

The ID of the customer whose email address has been opted out of data sale.

Anchor to DataSaleOptOutPayload.userErrors
userErrors
[DataSaleOptOutUserError!]!
non-null

The list of errors that occurred from executing the mutation.

Was this section helpful?
Hide code
Mutation reference
Copy
mutation dataSaleOptOut($email: String!) {
  dataSaleOptOut(email: $email) {
    customerId
    userErrors {
      field
      message
    }
  }
}
Hide code
Input
Copy
{
  "email": "<your-email>"
}