| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
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: (1) By an external customer ID, such as (2) By the Bloomreach Engagement internal ID, which can be found in the URL of a customer. Open the customer in See the formats below. Max 1000 customers. | At least 1 required. |
Customers available formats
| Parameter | Format |
|---|---|
External ID, in this example: registered | {"customer_ids": {"registered": "[[email protected]](mailto:[email protected])"}} |
| Bloomreach Engagement 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.
NoteThe
bulk_idresponse field identifies the request, not the outcome. If you experience issues with a bulk anonymization, provide thebulk_idto Bloomreach Support for faster investigation.