App endpoint

Use the /app endpoint to automate creating and updating new apps.

Create a new app

Create a new app using settings from your template app. If your app already exists, you can update it with new settings using the force_update parameter.

POST https://settings.adjust.com/api/app

Parameters

Parameter	Data type	In	Description
`store_id`*	`String`	Body	Bundle ID (Android) \| Store ID (Apple)
`platform`*	`String`	Body	`android` \| `ios`
`name`*	`String`	Body	The name of your app.
`bundle_id`*	`String`	Body	The Bundle ID of your app.
`android_signature_hash`	`String`	Body	SHA1 hash. Generated from the keystore file to build the SDK signature.
`channel_setup`	`Object`	Body	Required to set up partner modules for your app. See the Channel setup article for more information.
`editors`	`String`	Body	List of emails of users who should have access to the app.
`template_app_token`	`String`	Body	Adjust app token to use as a template. Required if you aren’t using a template app.
`force_update`	`Boolean`	Body	Pass this value as true to update an existing app’s settings.

Response parameters

Parameter	Data type	Description
`adjust_app_token`	`String`	Adjust App Token to be used in SDK integration and other API requests.
`name`	`String`	The name of your app.
`sk_app_id`	`Integer`	The StoreKit app ID for your iOS app.
`store_id`	`String`	Bundle ID for Android \| Store ID for Apple
`bundle_id`	`String`	Bundle ID for Android or iOS app
`ticket_token`	`String<UUID>`	Ticket ID to check the current job status. See the Status endpoint document for more information.

Example

$ curl \
--header "AdjustAuthorization: Token <adjust api token>" \
--header "Content-Type: application/json" \
--data '{ "name":"Test App Name", "bundle_id":"test.bundle.app", "store_id":"test.bundle.app", "platform":"android", "channel_setup": { "facebook": {"app_id": "123456789"} } }' \
-X POST https://settings.adjust.com/api/app

{
   "adjust_app_token": "p77yk727r18g",
   "name": "Test App Name",
   "sk_app_id": null,
   "store_id": "test.bundle.app",
   "bundle_id": "test.bundle.app",
   "ticket_token": "af7702a9-ba95-6ba2-bdac-3f83e55ed8d3"
}

Fetch app details

Retrieve details about an app using the app store ID and platform name.

GET https://settings.adjust.com/api/app?store_id={}&platform={}

Parameters

Name	Data type	In	Description
`store_id`*	`String`	Query	Bundle ID for Android \| Store ID for Apple
`platform`*	`String`	Query	`android` \| `ios`

Response parameters

Name	Type	Description
`name`	`String`	The name of the app
`platform`	`String`	`android` \| `ios`
`store_id`	`String`	Bundle ID for Android \| Store ID for iOS
`adjust_app_token`	`String`	The token of the requested app.
`additional_info`	`Object`	All app details previously received by the endpoint.
`channel_setup`	`Object`	Partner-specific parameters, see Channel Setup
`cross_promo_token`	`String`	Adjust link token to be used for CrossPromotion (once available)
`android_signature_hash`	`String`	SHA1 hash, generated from the keystore file to build the SDK signature

Example

$ curl \
--header "AdjustAuthorization: Token <adjust api token>" \
-L -X GET 'https://settings.adjust.com/api/app?store_id=test.bundle.app&platform=android'

{
   "name": "Test App Name",
   "platform": "android",
   "store_id": "test.bundle.app",
   "adjust_app_token": "p77yk727r18g",
   "additional_info": { "overrides": {} },
   "channel_setup": {
      "facebook": { "app_id": "123456789" },
      "snapchat": { "app_id": "test.bundle.app" }
   },
   "cross_promo_token": "hgj3li1",
   "android_signature_hash": "FF:FF:FF:FF:FF:FF:FF:FF:FF:FF:FF:FF:FF:FF:FF:FF:FF:FF:FF:FF"
}

Fetch app details by Adjust token

Retrieve details about an app using the adjust app token.

GET https://settings.adjust.com/api/app/{adjust_app_token}

Parameters

Name	Data type	In	Description
`adjust_app_token`*	`String`	Path	The Adjust app token. You can find this in the Adjust dashboard or in your /app POST response.

Response parameters

Name	Type	Description
`name`	`String`	The name of the app
`platform`	`String`	`android` or `ios`
`store_id`	`String`	Bundle ID for Android \| Store ID for iOS
`adjust_app_token`	`String`	The token of the requested app.
`additional_info`	`Object`	All app details previously received by the endpoint.
`channel_setup`	`Object`	Partner-specific parameters, see Channel Setup
`cross_promo_token`	`String`	Adjust link token to be used for CrossPromotion (once available)
`android_signature_hash`	`String`	SHA1 hash, generated from the keystore file to build the SDK signature

Example

$ curl \
--header "AdjustAuthorization: Token <adjust api token>" \
-X GET https://settings.adjust.com/api/app/p77yk727r18g/

{
   "name": "Test App Name",
   "platform": "android",
   "store_id": "test.bundle.app",
   "adjust_app_token": "p77yk727r18g",
   "additional_info": { "overrides": {} },
   "channel_setup": {
      "facebook": { "app_id": "123456789" },
      "snapchat": { "app_id": "test.bundle.app" }
   },
   "cross_promo_token": "hgj3li1",
   "android_signature_hash": "FF:FF:FF:FF:FF:FF:FF:FF:FF:FF:FF:FF:FF:FF:FF:FF:FF:FF:FF:FF"
}

Fetch app channels

Retrieve a list of channels that have active links for an app.

GET https://settings.adjust.com/api/app/{adjust_app_token}/channels

Parameters

Name	Data type	In	Description
`adjust_app_token`*	`String`	Path	The Adjust app token. You can find this in the Adjust dashboard or in your /app POST response.

Response parameters

Parameter	Data type	Description
`channels`	`Array <String>`	A list of network slugs for active channels for this app.

Example

$ curl \
--header 'AdjustAuthorization: Token <adjust api token>' \
--header "SignatureAuthorization: Token <adjust signature token>" \
--X GET 'https://settings.adjust.com/api/app/927t3s86rzsw/channels'

[
   "unityads",
   "digitalturbine",
   "jetfuel_api",
   "jetfuel",
   "criteo",
   "tapjoy",
   "bytedance",
   "moloco",
   "adikteev",
   "pinsightmedia",
   "applovin",
   "aura_ironsource",
   "freakout",
   "tradedoubler"
]

Enable signature verification

If you’re using the Adjust v3 Signature library to secure your app traffic, you can use the automation API to configure your app’s certificate fingerprints.

Instructions

Send a POST request to the /app endpoint with the following information:

name: The name of your app
bundle_id: Bundle ID for Android | Store ID for Apple
store_id: The ID of your app in the target app store
platform: The target platform of the application
channel_setup: Required to set up partner modules for your app. See the Channel setup article for more information.

curl \
--header "AdjustAuthorization: Token <adjust api token>" \
--header "Content-Type: application/json" \
--data '{ "name":"Test App Name", "bundle_id":"test.bundle.app", "store_id":"test.bundle.app", "platform":"android", "channel_setup": { "facebook": {"app_id": "123456789"}, "snapchat": {"app_id": "test.bundle.app"} } }' \
-X POST https://settings.adjust.com/api/app

Contact your Adjust representative and ask them to enable Signature v3 support.

Once your app is marked for Signature v3 support, send another POST request to the /app endpoint with the following:

android_signature_hash: A comma-separated list of SHA-1 signatures in colon separated hex format.
A SignatureAuthorization header with the value of your Adjust signature token.

curl \
--header "AdjustAuthorization: Token <adjust api token>" \
--header "SignatureAuthorization: Token <adjust signature token>" \
--header "Content-Type: application/json" \
--data '{ "name":"Test App Name", "android_signature_hash": "45:a7:2b:82:00:f1:f6:99:d7:c5:1e:6e:1f:8c:91:b5:5c:f9:98:a2,44:40:16:6e:ed:36:cc:6d:6e:62:53:92:9e:ef:45:63:a1:3c:19:0c,57:44:3a:4c:05:23:50:a4:46:38:83:5d:64:fd:66:82:2f:81:33:19", "bundle_id":"test.bundle.app", "store_id":"test.bundle.app", "platform":"android", "channel_setup": { "facebook": {"app_id": "123456789"}, "snapchat": {"app_id": "test.bundle.app"} } }' \
-X POST https://settings.adjust.com/api/app