Search the Documentations
Export Profile Data
The Profile Delete allows you to mark user data for deletion given a user’s email or profileId.
Do I need to call it?
GDPR mandates that the user has a right to be forgotten, and this API allows you to respect that right in an automated way.
Request Parameters
You may perform requests to the API using the following curl equivalent:
curl -XGET -H 'Authorization: Bearer <secretKey>' 'https://releva.ai/api/v0/profiles?email=<email>&sendToEmail=your_email@gmail.com'
curl -XGET -H 'Authorization: Bearer <secretKey>' 'https://releva.ai/api/v0/profiles?profileId=<profileId>&sendToEmail=your_email@gmail.com'
curl -XGET -H 'Authorization: Bearer <secretKey>' 'https://releva.ai/api/v0/profiles?phoneNumber=<phoneNumber>&sendToEmail=your_email@gmail.com'Request URL Parameters
| Field | Type | Description |
|---|---|---|
| String (Optional) | User’s email address. | |
| profileId | String (Optional) | User’s profile id. |
| phoneNumber | String (Optional) | User’s phone number. |
| sendToEmail | String | Email that will receive the exported data. |
Note that email, profileId and phoneNumber are optional but we need exactly one of them.
A successful response will return HTTP Status 202 with an empty response body ({}).
Response Format
An error response will return a HTTP 4xx or 5xx status code and have the following structure:
{
"message": "A description of the error and how to fix it, if it's a client error."
}