Skip to main content
POST
/
customer
/
delete
Delete Users
curl --request POST \
  --url https://api-0{dc}.moengage.com/v1/customer/delete \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "identity_type": "customer_id",
  "identity_value": "6416d1a318r98264512c0f89"
}
'
{
  "status": "success",
  "message": "Your request has been accepted and will be processed soon."
}

​
Rate Limit

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

Authorizations

​
Authorization
string
header
required

Authentication is done via Basic Auth. This requires a base64-encoded string of your credentials in the format 'username:password'.

  • Username: Use your MoEngage workspace ID (also known as the App ID). You can find it in the MoEngage dashboard at Settings > Account > APIs > Workspace ID (earlier app id).
  • Password: Use your API Key, which you can find within the Data tile.

Note: After you generate and save the Data API Key, DO NOT generate a new key unless there is a security breach. After you generate a different Data API key and save it, the authentication will start failing. You must update your existing data tracking.

For more information on authentication and getting your credentials, refer here.

Headers

​
X-Forwarded-For
string

The 'X-Forwarded-For' header is used to specify the IP address of the client that made the request. This header may be added by proxy servers or load balancers. The header value must contain the IP address of the original client that initiated the request. Multiple IP addresses may be specified in the header value, separated by commas.

Example:

"203.0.113.195"

Query Parameters

​
app_id
string
required

This is the Workspace ID of your MoEngage account that must be passed with the request. You can find it in the MoEngage dashboard at Settings > Account > APIs > Workspace ID (earlier app id).

Example:

"VJ0GSMESHMQA3L7WV1EEK3UR"

Body

application/json
​
identity_type
enum<string>

This field specifies the identifier type. Identifier types can either be customer_id (ID field in the User Profile) or moengage_id (the MoEngageID of the user in the User Profile). Allowed values are "moengage_id", "customer_id".

Available options:
customer_id,
id
Example:

"customer_id"

​
identity_value
string

This field specifies the unique identifier that identifies the user.

Example:

"6416d1a318r98264512c0f89"

Response

This response is returned when the request is processed successfully.

​
status
string

This field contains the status of the request and specifies whether the request was successful. Supported values are success, fail

Example:

"success"

​
message
string

This field contains information about whether the response is being processed, the user is deleted, and so on.

Example:

"Your request has been accepted and will be processed soon"