App Settings

These endpoints manage persistent settings for an entire app, sharing data and validation with Dashboard. Continue using App Info for individual build details.

Read App Settings

Returns current settings and available operations. GET is also supported, but POST avoids placing your API Key in the URL.

Request Parameters

Response

{
  "code": 0,
  "message": "",
  "data": {
    "appKey": "0123456789abcdef0123456789abcdef",
    "appDownloadStatus": 1,
    "appDownloadNameType": 2,
    "appAutoSync": 2,
    "appDisplayAds": 1,
    "appLang": 3,
    "appFeedbackStatus": 2,
    "appShowPgyerCopyright": 1,
    "appDisplayInstallGuide": 1,
    "appDisplayHistory": 1,
    "buildVersionType": 1,
    "buildInstallType": 2,
    "buildPasswordSet": true,
    "appInstallQuestion": "",
    "appInstallAnswerSet": false,
    "appIsInstallDate": 2,
    "appInstallStartDate": "",
    "appInstallEndDate": "",
    "appSameVersionCleanupAvailable": true,
    "appSameVersionCleanup": 2,
    "appSameVersionCleanupRevision": 0,
    "allowedInstallTypes": [1, 2, 3, 4, 5],
    "abmEnabled": false
  }
}

Update App Settings

Send only fields you want to change. Omitted settings are preserved. All fields are saved together; if any field fails validation, the entire request is rejected without applying any changes.

Request Parameters

Send an application/x-www-form-urlencoded form containing _api_key, appKey, and at least one setting. Unknown fields, arrays, null values and invalid enums are rejected. Switches use the existing API convention of 1 / 2, not 0 / 1.

Language codes: 1 Simplified Chinese, 2 English, 3 auto, 4 Russian, 5 French, 6 German, 7 Italian, 8 Japanese, 9 Polish, 10 Spanish, 11 Thai, 12 Traditional Chinese. Responses always return a numeric appLang.

Changing installation mode clears credentials that no longer apply. Unrelated fields remain unchanged. If ABM installation is enabled, disable it in Dashboard before changing installation mode. Use the existing management interface for TestFlight apps or apps without a published build.

Automatic Same-Version Cleanup

When enabled, subsequent new uploads trigger cleanup after successful publication and approval. Historical versions of this app with the same version number are eligible; Build numbers may differ. The most recently published build for that version number and protected builds are retained. Saving the setting does not itself run cleanup.

This setting is independent of account storage quota policies: it does not require exceeding quota and does not wait for the quota enforcement date. Web and API uploads both follow it without an additional upload parameter. The default is disabled, and it applies only to new uploads after enabling it.

Read the latest revision before changing the switch. This prevents overwriting a more recent change from Dashboard or another API client. After error 1402, read again and confirm the intended value rather than blindly retrying the old revision.

Permissions

Reading and updating ordinary settings follow Dashboard app-management permissions. Only the owning main account can manage same-version cleanup; other authorized members can still manage ordinary settings. An account API Key cannot manage an unauthorized app. Existing restrictions on subaccount API Keys remain unchanged.

Response

On success, code=0 and data contains the saved settings in the same format as the read endpoint. Example error:

{"code": 1402, "message": "清理设置已变化，请重新查询后再提交"}

Examples

Read settings:

curl -X POST 'https://www.pgyer.com/apiv2/app/settings' \
  --data-urlencode "_api_key=$PGYER_API_KEY" \
  --data-urlencode 'appKey=0123456789abcdef0123456789abcdef'

Change only version-history visibility and language:

curl -X POST 'https://www.pgyer.com/apiv2/app/updateSettings' \
  --data-urlencode "_api_key=$PGYER_API_KEY" \
  --data-urlencode 'appKey=0123456789abcdef0123456789abcdef' \
  --data-urlencode 'appDisplayHistory=1' \
  --data-urlencode 'appLang=en'

Enable same-version cleanup. Replace the example revision of 0 with the actual revision from your read response:

curl -X POST 'https://www.pgyer.com/apiv2/app/updateSettings' \
  --data-urlencode "_api_key=$PGYER_API_KEY" \
  --data-urlencode 'appKey=0123456789abcdef0123456789abcdef' \
  --data-urlencode 'appSameVersionCleanup=1' \
  --data-urlencode 'appSameVersionCleanupRevision=0'