API Reference

Update a store platform

patch
https://api.purchasely.io/management/v1/applications//platforms/

Update a store platform's settings and/or credentials for an application. Credential fields are write-only and never returned.

Required scope: setup.platforms:edit

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

Public ID of the resource.

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
string

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

string

Store package / bundle identifier. Cannot be changed once a purchase has been made.

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.

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.

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.

string

huawei only — the Huawei AppGallery OAuth client 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

string

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

string

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

string

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

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).

Responses

Updated 24 days ago

Did this page help you?
Language
Credentials
Bearer
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 24 days ago

Did this page help you?