Overview

This API can be used to delete users in MoEngage. Users cannot be retrieved once deleted. Users deleted (hard delete) using this API will be deleted after a default buffer of 24 hours. During this buffer period, the user will still be active in MoEngage and will be visible in Segments, Analytics, and Campaigns. Users can be updated in the buffer period.
After the buffer elapses, the user is hard-deleted from MoEngage. If a user with the same unique identifiers as the deleted one is created in MoEngage (through APIs or imports), they will be created again in MoEngage.

API Endpoint

POST https://api-0X.moengage.com/v1/customer/delete/bulk

Each customer is hosted on a different data center; you can find your data center number (value of X) by checking the data center and API endpoint mapping page.

Authentication

The API requests will be authenticated through Basic Authentication.

The API request will be authenticated through Basic Authentication. Basic Authentication sends a Base64-encoded string containing your username and password with every API request. It encodes a 'username:password' string in Base64 and appends the encoded string with 'Basic '. This string is included in the authorization header as shown below:

{"Authorization: Basic Base64_ENCODED_APPKEY_APIKEY=="}

The username and password details can be obtained from the MoEngage Dashboard. We've revamped the settings UI in the Dashboard. If you're using the API for the first time, follow these steps for the revamped and old UIs:

Revamped UI

1. Navigate to Settings -> Account -> APIs.
2. Click Generate Key in the Data tile in the API Keys section, and click Save.
3. Use the Workspace ID as the username and the Data API Key as the password to generate the authentication header.

Old UI

1. Navigate to Settings -> APIs -> DATA API Settings.
2. Click Generate Key.
3. Click Save on the Data APIs settings section. 
4. Use the DATA API ID as the username and the DATA API KEY as the password to generate the authentication header.

Request Parameters

Request Headers

Request Body

Response

Response Codes

Rate Limit

The rate limit is 1 user per payload per request. You can run 5000 requests per minute.

Sample cURL Request

curl --location 'https://api-01.moengage.com/v1/customer/delete/bulk?app_id=VJ0GSMESHMQA3L7WV1EE2K3UR' \
--header 'X-Forwarded-For: 34.249.175.81' \
--header 'Content-Type: application/json' \
--header 'Authorization: Basic e3tEQVRBIEFQSSBJRH19Ont7REFUQSBBUEkgS0VZfX0=' \
--data '{
    "identity_type": "moengage_id/customer_id",
    "identity_value": "{{moengage_user_id_or_uid_that_you_want_to_delete}}"
}
'

Sample Response

Success Response
{
    "status": "success",
    "message": "Your request has been accepted and will be processed soon."
}
    

Sample Response for Bad Requests
{
    "status": "fail",
    "error": {
        "message": "User doesn't exists with customer id b3XSJ7iXvqlCcrYGd5SB5m2m93eG9-9e9HPXd9GtufHvHueWm-mnuiAxUk7DGI1MKg==",
        "type": "Not Found",
        "request_id": "bYvNTyWb"
    }
}

Sample Response for Authorization Errors
{
    "status": "fail",
    "error": {
        "message": "App Secret key mismatch. Please login to the dashboard to verify key",
        "type": "Authentication required",
        "request_id": "AJCBfqoj"
    }
}

Sample Response for Blocked/Suspended Accounts
{
    "status": "fail",
    "error": {
        "message": "given app_id is invalid/blocked",
        "type": "InvalidParams",
        "request_id": "bYvNTyWb"
    }
}

Sample Response for Rate Limit Breach{  
     title="Rate-Limit Reached", 
     description="Exceeded rate limit for this url"
}    

Sample Response for Unknown Errors
{ 
    title="Internal Error", 
    description="Please Contact Moengage Team" 
}

Postman Collections

We have made it easy for you to test the APIs. Click here to view it in Postman.

FAQs

1. Can you reverse a delete operation?

   There are no rollback mechanisms for undoing the delete action. Once the delete request is processed, the user is deleted from MoEngage.

2. Are the events of the users also deleted as well?
   

   No, the events corresponding to a user are not specifically deleted; only the user and the user attributes are deleted when the delete API request is processed.

   However, once the user is deleted from MoEngage, the events corresponding to the user will not be accessible, i.e., if the event is used in a segmentation query the deleted user who had executed the event will not be added to the calculated segment or campaign. 
3. How do you check if a user has been deleted from MoEngage?

   Navigate to Segment -> Create Segment on the MoEngage Dashboard. Type the unique identifier for the deleted user (the unique identifier could be the ID, MoEngage ID, phone number, email, or any unique identifer that you've configured). If the user has been deleted (hard delete), you will not be able to get any search results. For more information about searching users, refer to Search User in Segmentation.