redactCustomerPersonalData

Requires permission customers:privacy:manage.

Anonymize one customer's personal data and tell every app holding customer data (customers.redact). dryRun defaults to true (preview only). Needs the customer privacy permission.

Errors: a failed call returns a GraphQL errors entry, not a field on the result, and data may be null or partial. Read the entry's extensions.code and message; every shape and code is in the Error reference.

Example:

GraphQL

mutation RedactCustomerPersonalData($confirmationCode: String!, $customerId: ID!, $dryRun: Boolean!) {
  redactCustomerPersonalData(
    confirmationCode: $confirmationCode
    customerId: $customerId
    dryRun: $dryRun
  ) {
    dryRun
    perModelCounts
    requestId
    retainedNote
    totalRows
  }
}

cURL

curl -X POST "https://<api-host>/graphql" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  --data @- <<'EOF'
{
  "query": "mutation RedactCustomerPersonalData($confirmationCode: String!, $customerId: ID!, $dryRun: Boolean!) {\n  redactCustomerPersonalData(\n    confirmationCode: $confirmationCode\n    customerId: $customerId\n    dryRun: $dryRun\n  ) {\n    dryRun\n    perModelCounts\n    requestId\n    retainedNote\n    totalRows\n  }\n}",
  "variables": {
    "confirmationCode": "string",
    "customerId": "id",
    "dryRun": true
  }
}
EOF

Variables:

{
  "confirmationCode": "string",
  "customerId": "id",
  "dryRun": true
}

Response:

{
  "data": {
    "redactCustomerPersonalData": {
      "dryRun": true,
      "perModelCounts": "string",
      "requestId": "string",
      "retainedNote": "string",
      "totalRows": 0
    }
  }
}

redactCustomerPersonalData(
  confirmationCode: String!
  customerId: ID!
  dryRun: Boolean! = true
): CustomerRedactionResult!

Arguments

redactCustomerPersonalData.confirmationCode ● String! non-null scalar

The customer's code, typed again to confirm the redaction.

redactCustomerPersonalData.customerId ● ID! non-null scalar

The customer to redact, in your organization.

redactCustomerPersonalData.dryRun ● Boolean! non-null scalar

True (the default) only counts the rows that would change and tells no app.

Type

CustomerRedactionResult object

The result of redacting one customer's personal data. A dry run writes nothing and tells no app.