Loyalty Admin API

Write Call

CancelCustomerDeletion3

Cancel a pending deletion of one customer's account and reinstate it (undelete). Works only inside the retention window, before the data is destroyed. Identify the customer by bhid.

Kind Write API call
Method POST
URL https://app.bubblehouse.com/api/v2023061/<shop>/CancelCustomerDeletion3
Authentication Admin Customer TokenShop Token

If the account is marked for deletion and still within the guaranteed retention window, the deletion request is cancelled and the account is reinstated. See RequestCustomerDeletion3.

Identify the customer by bhid: an account marked deleted is no longer found by email.

One adjustment per call. To apply several adjustments in one request, or for the less common actions, use AdjustCustomerState3.

Input

  • customer CustomerIdentity1 required if using a shop token

    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

Reinstate an account

Request

{
  "customer": {
    "bhid": "1086983a00000042"
  }
}

Response

{
  "ok": true
}

Global Errors

Status Error Reason & Examples
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.

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: You are over the read limit per second for this customer

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: The token has expired

Previous
AdjustCustomerTier3