Delete User Profile

The Delete User Profile API allows you to delete your customer and their associated data when necessary.

For example, your customer might have selected GDPR’s “right-to-be-forgotten” option, and you need to delete that customer's data. This is where the Delete API comes in. You can call this API with the related identifier for Insider to find that customer’s data and then delete it.

Endpoint and Headers

POST https://unification.useinsider.com/api/user/v1/delete

Headers

Body Parameters

Each POST body must have a unifier field under the identifiers object that you decided on. You can use the default identifiers, such as email, phone number, uuid, and the new custom identifier, to define a unifier. For example, if you decide to use the email field as a unifier, data without the email field will not be accepted.  

Sample Requests

Sample Request without Custom Object

The sample below displays a request to delete a user profile using default identifiers.

curl --location --request POST 'https://unification.useinsider.com/api/user/v1/delete' \
--header 'X-PARTNER-NAME: mybrand' \
--header 'X-REQUEST-TOKEN: 1a2b3c4d5e6f' \
--header 'Content-Type: application/json' \
--data-raw '{
   "identifiers":{
      "email":"sample@useinsider.com"
   }
}'

Sample Request with Custom Object

The sample below displays a request to delete a user profile using a custom identifier.

curl --location --request POST 'https://unification.useinsider.com/api/user/v1/delete' \
--header 'X-PARTNER-NAME: mybrand' \
--header 'X-REQUEST-TOKEN: 1a2b3c4d5e6f' \
--header 'Content-Type: application/json' \
--data-raw '{
  "identifiers": {
    "custom": {
      "custom_identifier": "xyz123"
    }
  }
}'

Sample Request with insider_id

The sample below displays a request to delete a user profile using their insider_id, an internal ID maintained by Insider for each user (shown as the Profile ID on the User Profiles page).

curl --location --request POST 'https://unification.useinsider.com/api/user/v1/delete' \
--header 'X-PARTNER-NAME: mybrand' \
--header 'X-REQUEST-TOKEN: 1a2b3c4d5e6f' \
--header 'Content-Type: application/json' \
--data-raw '{
  "insider_id":"hereisasampleinsiderid"
}'

Sample Responses

200 OK

{}

403 Forbidden

This response indicates that you have no access to use this endpoint. It might be due to various reasons, such as using the wrong API key.

{
    "success": false,
    "message": "Access Denied. You do not have sufficient access to perform this action."
}

404 Not Found

You receive this response if the identifier doesn't exist, meaning no user has that identifier.

{}

500 Internal Server Error

{
    "success": false,
    "message": "The request processing has failed because of an unknown error."
}

Limitations

• All functions must be executed with a simple HTTPS POST request.
• Only a delete request can be sent via this API. No data can be retrieved.
• The request token should be provided in the request header. If the token is incorrect, the operation will not be executed.
• A single HTTPS POST request can pass only 1 record (user).
• A maximum of 1,000 requests can be sent per minute.
• The entire request must not exceed 5 MB.
• The value of X-PARTNER-NAME header should be lowercase.