Store a VPP token

⚠️ iOS/iPadOS/tvOS only.

Uploads a VPP token file to the Esper tenant to enable Apple App Store app distribution on managed iOS devices.

Submit the token as multipart/form-data; on success, Esper stores the token and returns the new VPPToken record with its assigned id for use in subsequent operations.

About Upload VPP Token

A VPP (Volume Purchase Program) token is a .vpptoken file downloaded from an Apple Business location's Apps & Books settings. Uploading it to Esper grants the tenant the ability to assign and install App Store apps on enrolled iOS devices without requiring individual Apple IDs on each device. Esper recommends creating a dedicated Apple Business location specifically for your Esper MDM integration before downloading and uploading the token. If migrating from another MDM platform, the existing VPP token should be migrated to avoid losing app licenses.

Key Fields / Query Parameters

filename (form field, binary) — The .vpptoken file downloaded from Apple Business.

Common Use Cases

Initial setup of iOS app management after configuring Apple MDM Management in Esper

Migrating a VPP token from a previous MDM platform to Esper

Adding a second VPP token for a new Apple Business location or region

Best Practices

Create and use a dedicated Apple Business location for Esper before downloading the VPP token to avoid conflicts with other MDM platforms sharing the same token.

Download the token from the correct MDM server entry in Apple Business (it will match the location name).

After upload, verify the token was stored correctly via GET /api/tenant/v0/vpptokens/ before assigning apps to devices.

Workflow

In Apple Business, create a location dedicated to Esper MDM and navigate to Settings > Payments & Billing > Apps & Books.

Select the linked Esper MDM server and download the .vpptoken file.

POST the file as multipart/form-data to /api/tenant/v0/vpptokens/.

Confirm the returned VPPToken record and note the id for future reference.