v1

latestOpenAPI 3.0.1Apache 2.02026-08-063494581.6 MB
apps_management_VPP App Management

Set Preferred Region for VPP App

⚠️ Apple devices only. This endpoint applies exclusively to iOS devices managed via VPP (Volume Purchase Program).

Sets the preferred App Store region for a specific VPP app, overriding the default storefront used when Esper fetches app metadata and updates for that app.Each VPP app can be assigned to one of the preferred regions configured at the tenant level. Assigning the correct region is important for update reliability — devices in a region that doesn't match the app's assigned storefront may fail to receive app updates.

About VPP App Preferred Region

Apple's App Store is region-segmented; the same app may exist under different storefronts with different availability, pricing tiers, and update cadences. When managing VPP apps across a multi-region fleet, Esper needs to know which App Store storefront to use for each app. This endpoint sets that per-app region preference. The available regions to select from are those already configured at the tenant level via POST /v2/preferred-regions (up to five). In the Console, this setting is accessible when adding or editing an app under Apps > VPP Apps.

Key Fields

appleAppId (path, required) — the Apple numeric App Store ID for the VPP app (e.g., 361309726)

preferred_region (required) — ISO 3166-1 alpha-2 country code (uppercase) for the desired App Store storefront (e.g., "US", "GB", "AU"); must be one of the regions already added to the tenant's preferred region list

Common Use Cases

Assigning each VPP app to the App Store storefront matching the primary device region where it is deployed Correcting a region mismatch when devices in a specific country are failing to receive app updates Reconfiguring app storefronts after an organizational expansion into a new country Best Practices

Only assign a region that is already in the tenant's configured preferred region list — the available options are set via POST /v2/preferred-regions Match the app's region to the physical operating region of the devices it is assigned to, not the billing region of the VPP token Audit per-app region assignments when expanding into new countries to prevent silent update failures Workflow

Confirm the desired country is in the tenant's preferred region list via GET /v2/preferred-regions PUT to /v2/itunesapps/{appleAppId}/preferred-region with { "preferred_region": "US" } (or the appropriate code) Verify the response message confirms success; subsequently, device updates for that app will use the assigned storefront

put/v2/itunesapps/{appleAppId}/preferred-region

Path parameters

appleAppIdstring required

The Apple App Store ID of the VPP app (e.g., "361309726")

Request body

preferred_regionstring required

ISO 3166-1 alpha-2 country code for the preferred App Store region (e.g., 'US', 'JP')

Example request

{
  "preferred_region": "US"
}

Response

Success

Example response

{
  "content": {
    "message": "Preferred region updated successfully"
  }
}