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"
}
'Submit a GDPR / CCPA Data Request
GDPR or CCPA API ensures all the rights of users are created or updated for GDPR or CCPA compliance. You can erase the personal data of specific users as defined under GDPR using the Erase API.
For more details on compliance with MoEngage, refer to GDPR-Implementation and CCPA-Implementation.
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"
}
'Rate Limit
The maximum limit per request is 100 KB. The maximum payload size is 128 KB.承認
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.
パスパラメータ
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
ボディ
The GDPR/CCPA request payload, containing the type of request and the user identities.
The main object representing a GDPR or CCPA compliance request.
This is used to request for GDPR details or request to erase the GDPR details
"erasure"
This identifies the time when the request was sent.
"2018-10-05T15:00:00Z"
This provides the details of the user, such as email address, phone number, and so on.
Show child attributes
Show child attributes
This identifies the API version used to send the GDPR request.
"1.0"
レスポンス
Success. This response is returned when the request is processed successfully.
Standard successful response object for a submitted GDPR request.