Loyalty Admin API
Write CallRequestCustomerDeletion3
Request deletion of one customer's account and data (GDPR erasure, right to be forgotten). The account is marked deleted now and the data is destroyed after the retention period.
| Kind | Write API call |
|---|---|
| Method | POST |
| URL | https://app.bubblehouse.com/api/v2023061/<shop>/RequestCustomerDeletion3 |
| Authentication | Admin Customer TokenShop Token |
The customer's account is marked as deleted, and the data is queued to be physically destroyed after the configured retention period. Until then CancelCustomerDeletion3 can reinstate the account.
One adjustment per call. To apply several adjustments in one request, or for the less common actions, use AdjustCustomerState3.
Input
-
A customer to operate upon, when using a shop token.
If you're using a customer token and decide to pass this field (which we do not recommend), it must match the customer from the token.
Output
A successful response has no meaningful properties and only contains an ok property always set to true:
{"ok": true}
Usage Examples
Erase a customer on request
Request
{
"customer": {
"email": "alice@example.com"
}
}
Response
{
"ok": true
}
Global Errors
| Status | Error | Reason & Examples |
|---|---|---|
| 429 | rate_limit_exceeded |
Your usage is over the rate limit. Ensure that you're not making duplicate calls, and contact our team for a rate limit increase. For example: |
| 400 | invalid_global_api_version |
The global API version you are trying to use has never existed. |
| 401 | invalid_token |
The provided authentication token is invalid or has expired. For example: |
| 400 | inaccessible_global_api_version |
The global API version you are trying to use is not enabled on your account. |
| 400 | obsolete_global_api_version |
The global API version you are trying to use is no longer supported. |