User Deletion API

Credentials

First, if it hasn't been already done, ask your Adikteev Account Manager to create your Adikteev account in order to use Adikteev APIs. You will then receive an email to setup your password.

If you are already using Adikteev Reporting API or Custom Audience API, your credentials for the User Deletion API are the same.

If you need to reset your API password at any point, please use this password recovery link.

Step 1 - Authenticating your API client

The Adikteev APIs uses the OAUTH2 protocol for authentication. In order to get your API access token, you must make a POST request to the token delivery endpoint :

API route

https://public-api.adikteev.com/token

Mandatory header

• authorization: Basic cmVwb3J0aW5nX2Rhc2hib2FyZDo=

Request body You must replace the email and password with the credentials you got in previous step

username=YOUR_EMAIL&password=YOUR_PASSWORD&grant_type=password

If your email and password are valid, you will receive a JSON response containing a token valid for 30 days.

curl -H 'authorization: Basic cmVwb3J0aW5nX2Rhc2hib2FyZDo='
--data 'username=hello@adikteev.com&password=mypassword&grant_type=password' 
-X POST 'https://public-api.adikteev.com/token'

{
  "access_token": "abcdef98765",
  "token_type": "bearer",
  "expires_in": 2592000
}

Step 2 - Fetching your company identifier

Your Adikteev company ID for the platform is a required parameter for the next steps. In order to fetch it, you can send an authenticated HTTP GET request to this endpoint.

API route

https://public-api.adikteev.com/profile

Mandatory headers

• authorization: Bearer YOUR_ACCESS_TOKEN

The body of the API response will contain a numeric identifier that needs to be stored for reuse under field company_id.

Sample profile fetching request using cURL

curl -H 'authorization: Bearer abcdef98765'
-X GET 'https://public-api.adikteev.com/profile'

Sample successful profile fetching response

{
  "id": 123456789,
  "email": "hello@adikteev.com",
  "company_id": 456,
  "role": "client"
}

Step 3 - Upload the user list you want to delete from Adikteev database

Every upload of a device ID list will delete all the users from Adikteev audiences. A properly authenticated HTTP POST request is required to get a valid status code.

Each request must have a valid bundle_id and os to delete the list of users properly. 

API route

https://public-api.adikteev.com/companies/YOUR_COMPANY_ID/userDeletionList

Mandatory header

• authorization: Bearer YOUR_ACCESS_TOKEN

Request parameters for a new list of iOS users

{"bundle_id": "YOUR_BUNDLE_ID", "os": "ios"}

Request body for a new list of Android users

{"bundle_id": "YOUR_BUNDLE_ID", "os": "android"}

When our API successfully takes deletion requests into account, it returns a new deletion ID, which you can be used to check the status of your deletion request. Please keep this ID to follow-up on the deletion process.