Suppression API

Version 1.1 / August 2024

Advertisers use the Suppression API to prevent existing app users from being targeted by a campaign for that app. The API supports enabling or disabling suppression for users. You can identify users using their IDFA on iOS or GAID on Android.

Request Format

Target URLs

Use this API by making an HTTP request to one of the following base URLs:

• https://api.applovin.com/suppressionApps (Add users to the suppression list for an app)
• https://api.applovin.com/deleteSuppressionApps (Remove users from the suppression list for an app)

Authentication

This API requires that you include an API key as a query parameter (api_key) in the request:

https://api.applovin.com/suppressionApps?api_key=«management_key»
https://api.applovin.com/deleteSuppressionApps?api_key=«management_key»

You can find this Management Key in the Keys tab of your account page. If the Management Key is not visible, please open a ticket here and request one be generated for you.

Add Users

To add a list of users to the suppression list, make an HTTP POST request to:

https://api.applovin.com/suppressionApps?api_key=«management_key»&package_name=«package_name»

Delete Users

To remove a list of users from the suppression list, make an HTTP POST request to:

https://api.applovin.com/deleteSuppressionApps?api_key=«management_key»&package_name=«package_name»

Query Parameters

Name	Type	Description	Required
package_name	String	The bundle ID (iOS) or package name (Android) of the app	Yes

Post Body

The API accepts a newline-separated list of IDs in a POST request:

Type	Description	Required
List of Strings	A newline-separated list of Apple’s IDFA or Android’s GAID; the IDs must be in UUID format	Yes

Note

If the API request fails because the list of IDs is too large, AppLovin suggests that you break the list of IDs into smaller batches and submit them incrementally.

Response Format

The response is JSON-formatted:

Name	Type	Description
num_valid_ids	Integer	Number of IDs successfully processed in this request
num_invalid_ids	Integer	Number of invalid advertising IDs in this request

Errors

This API indicates errors by returning HTTP status codes:

HTTP Response Code	Description
200	Success.
400	The request was not formatted properly; it was missing data or had invalid data.
403	Authentication failed. Check the validity of the API Key.
500	Service Unavailable.

Example Requests

Example request to add users:

curl -X POST --data-binary @userIds.txt "https://api.applovin.com/suppressionApps?api_key=«management_key»&package_name=com.machinezone.gow"

Example request to delete users:

curl -X POST --data-binary @userIds.txt "https://api.applovin.com/deleteSuppressionApps?api_key=«management_key»&package_name=com.machinezone.gow"

Where the contents of the file userIds.txt are:

c77bbe4e-6a28-11e4-bcda-14109fdf9591
f601faf5-4a83-44d6-98ef-b67c24919d39

Example Response

{
  "num_valid_ids": 2,
  "num_invalid_ids": 0
}