mobileAppUpdateStatus

Public: no authentication required.

Tells a mobile app whether it is up to date, can be updated, or must be updated, with the latest version, store link and release notes. Needs no sign-in. When no release is recorded or the version cannot be read, the app is reported as up to date.

Errors: a failed call returns a GraphQL errors entry, not a field on the result, and data may be null or partial. Read the entry's extensions.code and message; every shape and code is in the Error reference.

Example:

GraphQL

query MobileAppUpdateStatus($bundleId: String!, $currentVersion: String!, $platform: MobileAppPlatform!) {
  mobileAppUpdateStatus(
    bundleId: $bundleId
    currentVersion: $currentVersion
    platform: $platform
  ) {
    latestVersion
    releaseNotes
    state
    storeUrl
  }
}

cURL

curl -X POST "https://<api-host>/graphql" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  --data @- <<'EOF'
{
  "query": "query MobileAppUpdateStatus($bundleId: String!, $currentVersion: String!, $platform: MobileAppPlatform!) {\n  mobileAppUpdateStatus(\n    bundleId: $bundleId\n    currentVersion: $currentVersion\n    platform: $platform\n  ) {\n    latestVersion\n    releaseNotes\n    state\n    storeUrl\n  }\n}",
  "variables": {
    "bundleId": "string",
    "currentVersion": "string",
    "platform": "ANDROID"
  }
}
EOF

Variables:

{
  "bundleId": "string",
  "currentVersion": "string",
  "platform": "ANDROID"
}

Response:

{
  "data": {
    "mobileAppUpdateStatus": {
      "latestVersion": "string",
      "releaseNotes": "string",
      "state": "UPDATE_AVAILABLE",
      "storeUrl": "string"
    }
  }
}

mobileAppUpdateStatus(
  bundleId: String!
  currentVersion: String!
  platform: MobileAppPlatform!
): MobileAppUpdateStatus!

Arguments

mobileAppUpdateStatus.bundleId ● String! non-null scalar

The app's bundle identifier.

mobileAppUpdateStatus.currentVersion ● String! non-null scalar

The version the app is running.

mobileAppUpdateStatus.platform ● MobileAppPlatform! non-null enum

The platform the app runs on.

Type

MobileAppUpdateStatus object

Whether the calling app needs updating.