Add a store platform

post

https://api.purchasely.io/management/v1/applications/{application_id}/platforms

Configure a store platform (app_store/play_store/amazon/huawei) for an application. Provide the store's credentials as flat fields; they are write-only and never returned. Stripe is connected out-of-band and cannot be configured here.

Required scope: setup.platforms:edit

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

application_id

string

required

Public ID of the resource.

Query Params

fields[]

array of strings

Field selection for token economy: an explicit list of field names to include in the response, or ["*"] for every field. Omit for this endpoint's own default field set.

fields[]

Body Params

app_id

string

app_store only — the numeric Apple App Store ID (Apple's "Apple ID" for the app).

app_package_id

string

required

Store package / bundle identifier (e.g. com.acme.app). Cannot be changed once a purchase has been made.

app_scheme

string

Used to preview paywalls. EITHER a bare URL-scheme name WITHOUT "://" (e.g. "myapp", not "myapp://") OR a full http/https universal-link prefix (e.g. "https://acme.com/app"). A scheme written with a trailing "://" is rejected.

app_store_connect_api_key_id

string

app_store only — the App Store Connect API Key ID (e.g. ABC123DEFG). Create the key in App Store Connect > Users and Access > Integrations > App Store Connect API. Used for Apple catalogue discovery (SKUs) and Retention Messaging. Distinct from the legacy In-App Purchase key (private_key_name / private_key_value). Write-only — never returned.

app_store_connect_api_key_value

string

app_store only — the full contents of the App Store Connect API private key (.p8 file, including the BEGIN/END PRIVATE KEY lines), paired with app_store_connect_api_key_id and issuer_id. Used for Apple catalogue discovery (SKUs) and Retention Messaging. Distinct from the legacy In-App Purchase key (private_key_name / private_key_value). Write-only — never returned.

client_id

string

huawei only — the Huawei AppGallery OAuth client id.

issuer_id

string

app_store only — the App Store Connect API Issuer ID (a UUID). Find it in App Store Connect > Users and Access > Integrations > App Store Connect API, at the top of the Active keys list. Write-only — never returned. Setup: https://docs.purchasely.com/docs/app-store-configuration

private_key_name

string

app_store only — legacy in-app-purchase private key name. Write-only.

private_key_value

string

app_store only — legacy in-app-purchase private key value. Write-only.

public_key

string

huawei only — the AppGallery public key. Write-only.

shared_app_secret

string

app_store: App-Specific Shared Secret. play_store: the Google service-account JSON credentials (as a JSON string). amazon/huawei: the store shared secret. Write-only — never returned. Setup: https://docs.purchasely.com/docs/app-store-configuration (iOS), https://docs.purchasely.com/docs/play-store-configuration (Android).

store

string

required

Which store to configure: app_store (iOS), play_store (Android), amazon, or huawei. Stripe is NOT configurable here (connected out-of-band via Stripe Connect).

Responses

Language

Credentials

Bearer

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

201Success.

403FORBIDDEN (missing/insufficient scope, wrong tenant) or, for feature-gated operations, FEATURE_NOT_ENABLED.

422VALIDATION_FAILED — one or more parameters were missing or invalid.

429RATE_LIMITED — the coarse per-key, per-write, per-heavy-read, or per-moderate-read rate limit tier was exceeded.