Skip to main content
POST
/
opengdpr_requests
/
{appId}
Submit a GDPR / CCPA Data Request
curl --request POST \
  --url https://api-{dc}.moengage.com/v1/opengdpr_requests/{appId} \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "request_type": "erasure",
  "submitted_time": "2018-10-05T15:00:00Z",
  "identities": [
    {
      "identity_type": "email",
      "identity_value": "[email protected]"
    }
  ],
  "api_version": "1.0"
}
'
{
  "status": "success",
  "message": "Your request has been accepted and will be processed soon.",
  "request_id": "a7551968-d5d6-44b2-9831-815ac9017798"
}
Warning: Multiple users cannot be deleted using this API in a single payload. If an email ID associated with multiple users is passed for an erasure request, all associated users will be deleted.

​
Rate Limit

The maximum limit per request is 100 KB. The maximum payload size is 128 KB.

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.

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

Path Parameters

​
appId
string
required

This is your MoEngage account's Workspace ID that must be included in the request. You can find your Workspace ID in the following navigation on the dashboard: Revamped UI: Settings > Account > APIs > Workspace ID

Body

application/json

The GDPR/CCPA request payload, containing the type of request and the user identities.

The main object representing a GDPR or CCPA compliance request.

​
request_type
string
required

This is used to request for GDPR details or request to erase the GDPR details

Example:

"erasure"

​
submitted_time
string<date-time>
required

This identifies the time when the request was sent.

Example:

"2018-10-05T15:00:00Z"

​
identities
object[]
required

This provides the details of the user, such as email address, phone number, and so on.

​
api_version
string
required

This identifies the API version used to send the GDPR request.

Example:

"1.0"

Response

Success. This response is returned when the request is processed successfully.

Standard successful response object for a submitted GDPR request.

​
status
string
Example:

"success"

​
message
string

A human-readable message confirming the request was accepted.

Example:

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

​
request_id
string<uuid>

A unique ID generated for the submitted request.

Example:

"a7551968-d5d6-44b2-9831-815ac9017798"