/data/v2/projects/{projectToken}/customers/anonymize_bulk
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
This method initiates anonymization of multiple customers. The anonymization process removes all Private information and all external identifiers and assigns a new cookie ID. Apart from customer IDs, the anonymize call only removes properties that have been marked as Private - "Personal Identifiable Information" (PII).
You need to manually specify which properties are Private in the Data manager within your Bloomreach project. Learn more about managing PII.
Definition
Authentication
In this API call you must use the following authorization access and permissions:
| Available access type | Permissions needed |
|---|---|
| Private access | GDPR > Anonymize customer |
Read more about authentication and access keys in the API groups section.
Path parameters
| Parameter | Type | Description | Required |
|---|---|---|---|
| projectToken | string | The ID of your project. | Required |
Body parameters
| Parameter | Type | Description | Required |
|---|---|---|---|
| customers | array of objects | List of customer identifiers to be anonymized. You can do that in 2 ways:
| At least 1 required. |
Customers available formats
| Parameter | Format |
|---|---|
External ID, in this example: registered | {customer_ids: {registered: `[email protected]`}} |
| Marketing internal ID | {internal_id: "57e99c7bfb60099395b94b6d"} |
Headers
| Parameter | Type | Description | Required |
|---|---|---|---|
| authorization | string | Used for authentication. Read more in the Authentication section. | Required |
| content-type | string | application/json | Required |
Additional payload example
{"customers": [
{"customer_ids": {"registered": "[email protected]"}},
{"customer_ids": {"registered": "[email protected]"}},
{"internal_id": "57e99c7bfb60099395b94b6d"}
]}Limitations
You can target a maximum of 1000 customers in a single bulk request.
The bulk_id response field identifies the request, not the outcome. If you experience issues with a bulk anonymization, provide the bulk_id to Bloomreach Support for faster investigation.