User Deletion API

Credentials

First, ask your Adikteev Account Manager to provide you with your client credentials in order to use Adikteev APIs, your email address and a password will be sent to you.

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

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

POST

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

GET

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 our database

Every upload of a device ID list will delete all the users from our targeting lists. 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 uploaded list. 

API route

POST

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

Mandatory header

• authorization: Bearer YOUR_ACCESS_TOKEN

Request parameters for a new iOS segment

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

Request body for a new Android segment

{"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 use to check the status of your deletion request. Please keep this ID to follow-up on the deletion process. 

curl -H 'authorization: Bearer abcdef98765'
--header 'Content-Type: application/json' \
--data-raw'["7918C635-6549-499D-8FC4-032E93204EC2","2CB9E560-C694-4428-ACCA-E7F117DFDFB7"]' -X POST 'https://public-api.adikteev.com/companies/82/userDeletionList?bundle_id=com.test.io&os=android'

{
"deletion_request_id": "165bfad9-484a-4576-be5c-3144c3681bb8"
}

How to retrieve a Bundle ID?

For Android

It's in the URL of the Google Play Store

For iOS

Some website as Apptopia with the name of your app.

⚠️ The app ID in the Apple app store is not supported by this API. 

[Optional] Step 4 - Check the deletion status

You can check the status of your deletion request by sending an authenticated HTTP GET request.

API route

GET

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

Mandatory header

• authorization: Bearer YOUR_ACCESS_TOKEN

You will receive the status of the deletion request: 

• “ok” → Request is treated

• “pending” → Request will be treated soon

• “error” → Request can’t be treated automatically. It will be done manually and you can contact your account manager to help you resolve it

Sample segment creation request using cURL

curl -H 'authorization: Bearer abcdef98765' 
'https://public-api.adikteev.com/companies/82/userDeletionList/{deletion_request_id}'

{
"deletion_request_id": "165bfad9-484a-4576-be5c-3144c3681bb8",
"status": "ok"
}