Personalization

Profile Delete Request

Deletes a single Entity (normally a user).

This API persists a deletion event for the particular profile provided. This operation is asynchronous; it will take some time for the profile to be removed from downstream databases and indexes. This request returns a "request_id" which may be used to determine the status of that deletion. While the profile may become unavailable quickly, it may take a while for the full process to complete since it includes all archived historic data.

# Delete user whose "user_id" = "userdeleteme12"
# user_id can be any by-field

curl -s -H "Authorization: $LIOKEY" \
  -XDELETE "https://api.lytics.io/api/entity/user/user_id/userdeleteme12" | jq '.'


Use Cases

  • GDPR right to be forgotten, a user asks for profile to be deleted.
delete/api/entity/{table}/{fieldname}/{fieldval}

Request

  • Base URL
    https://api.lytics.io
  • URL
    https://api.lytics.io/api/entity/{table}/{fieldname}/{fieldval}
  • Auth
    API key in header Authorization

Path parameters

tablestring required
fieldnamestring required

Field name of identity to use as lookup (could be email, user_id, etc)

fieldvalstring required

Field value of identity

Query parameters

account_idstring

Your Lytics account ID.

Response

OK

statusnumber
messagestring

Example response

{
  "status": 200,
  "message": "delete request received",
  "data": {
    "request_id": "e9d5f2d3d2c7a7d0e801-1526083200",
    "complete": false
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.