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 -XDELETE -H 'Content-Type: application/json' -H 'Authorization: Bearer <secretKey>' 'https://releva.ai/api/v0/profiles?email=<email>'
curl -XDELETE -H 'Content-Type: application/json' -H 'Authorization: Bearer <secretKey>' 'https://releva.ai/api/v0/profiles?profileId=<profileId>'
curl -XDELETE -H 'Content-Type: application/json' -H 'Authorization: Bearer <secretKey>' 'https://releva.ai/api/v0/profiles?phoneNumber=<phoneNumber>'

Request URL Parameters #

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."
}