--- updatedAt: 2026-06-15T13:51:20.000Z agentTools: siteIndex: https://developer.jamf.com/llms.txt projectIndex: https://developer.jamf.com/jamf-pro/llms.txt --- # Create a Mobile Device Prestage Create a mobile device prestage > 📋 **Required privilege:** Create Mobile Device PreStage Enrollments # OpenAPI definition ```json { "openapi": "3.0.1", "info": { "title": "Jamf Pro API", "termsOfService": "https://www.jamf.com/developer-resources/api-license-agreement", "version": "11.32.0" }, "servers": [ { "url": "https://yourServer.jamfcloud.com/api" } ], "x-readme": { "samples-languages": [ "curl", "swift", "ruby", "python" ], "explorer-enabled": false }, "security": [ { "Bearer": [] }, { "ApiClient": [] }, { "BasicAuth": [ "/v1/auth/token" ] } ], "paths": { "/v3/mobile-device-prestages": { "post": { "tags": [ "mobile-device-prestages" ], "summary": "Create a Mobile Device Prestage\n", "description": "Create a mobile device prestage\n\n> 📋 **Required privilege:** Create Mobile Device PreStage Enrollments", "requestBody": { "description": "Mobile Device Prestage to create. ids defined in this body will be ignored", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MobileDevicePrestageV3" } } }, "required": true }, "responses": { "201": { "description": "Mobile Device Prestage was created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HrefResponse" } } } } }, "x-required-privileges": [ "Create Mobile Device PreStage Enrollments" ] } } }, "components": { "schemas": { "DeviceEnrollmentPrestageV3": { "required": [ "authenticationPrompt", "autoAdvanceSetup", "defaultPrestage", "department", "deviceEnrollmentProgramInstanceId", "displayName", "enableDeviceBasedActivationLock", "enrollmentSiteId", "keepExistingLocationInformation", "keepExistingSiteMembership", "locationInformation", "mandatory", "mdmRemovable", "preventActivationLock", "purchasingInformation", "requireAuthentication", "supportEmailAddress", "supportPhoneNumber" ], "type": "object", "properties": { "displayName": { "type": "string", "example": "Example Mobile Prestage Name" }, "mandatory": { "type": "boolean", "example": false }, "mdmRemovable": { "type": "boolean", "example": true }, "supportPhoneNumber": { "type": "string", "example": "5555555555" }, "supportEmailAddress": { "type": "string", "example": "example@example.com" }, "department": { "type": "string", "example": "Oxbow" }, "defaultPrestage": { "type": "boolean", "example": false }, "enrollmentSiteId": { "type": "string", "example": "-1" }, "keepExistingSiteMembership": { "type": "boolean", "example": true }, "keepExistingLocationInformation": { "type": "boolean", "example": true }, "requireAuthentication": { "type": "boolean", "example": true }, "authenticationPrompt": { "type": "string", "example": "LDAP authentication prompt" }, "preventActivationLock": { "type": "boolean", "example": true }, "enableDeviceBasedActivationLock": { "type": "boolean", "example": true }, "deviceEnrollmentProgramInstanceId": { "type": "string", "example": "5" }, "skipSetupItems": { "type": "object", "additionalProperties": { "type": "boolean" }, "example": { "Location": true, "Privacy": false } }, "locationInformation": { "$ref": "#/components/schemas/LocationInformationV3" }, "purchasingInformation": { "$ref": "#/components/schemas/PrestagePurchasingInformationV3" }, "anchorCertificates": { "type": "array", "description": "The Base64 encoded PEM Certificate", "items": { "type": "string", "example": "xNE5HRgotLS0tLUVORCBDRVJUSUZJQ0FURS0tLS0tCg==" } }, "enrollmentCustomizationId": { "type": "string", "example": "2" }, "language": { "type": "string", "example": "en" }, "region": { "type": "string", "example": "US" }, "autoAdvanceSetup": { "type": "boolean", "example": true } } }, "HrefResponse": { "type": "object", "properties": { "id": { "minLength": 1, "type": "string", "example": "1" }, "href": { "type": "string", "example": "https://yourJamfProUrl.jamf/api/v1/resource/1" } } }, "LocationInformationV3": { "required": [ "buildingId", "departmentId", "email", "id", "phone", "position", "realname", "room", "username", "versionLock" ], "type": "object", "properties": { "username": { "type": "string", "example": "name" }, "realname": { "type": "string", "example": "realName" }, "phone": { "type": "string", "example": "123-456-7890" }, "email": { "type": "string", "example": "test@jamf.com" }, "room": { "type": "string", "example": "room" }, "position": { "type": "string", "example": "postion" }, "departmentId": { "type": "string", "example": "1" }, "buildingId": { "type": "string", "example": "1" }, "id": { "type": "string", "example": "-1" }, "versionLock": { "type": "integer", "example": 1 } } }, "MobileDevicePrestageNameV3": { "type": "object", "properties": { "id": { "type": "string", "example": "1" }, "deviceName": { "type": "string", "example": "iPad" }, "used": { "type": "boolean", "example": false } } }, "MobileDevicePrestageNamesV3": { "type": "object", "properties": { "assignNamesUsing": { "type": "string", "example": "List of Names" }, "prestageDeviceNames": { "type": "array", "items": { "$ref": "#/components/schemas/MobileDevicePrestageNameV3" } }, "deviceNamePrefix": { "type": "string", "example": "prefix" }, "deviceNameSuffix": { "type": "string", "example": "suffix" }, "singleDeviceName": { "type": "string", "example": "name" }, "manageNames": { "type": "boolean", "example": true }, "deviceNamingConfigured": { "type": "boolean", "example": true } } }, "MobileDevicePrestageV3": { "allOf": [ { "$ref": "#/components/schemas/DeviceEnrollmentPrestageV3" }, { "required": [ "allowPairing", "configureDeviceBeforeSetupAssistant", "maximumSharedAccounts", "multiUser", "sendTimezone", "storageQuotaSizeMegabytes", "supervised", "timezone", "useStorageQuotaSize" ], "type": "object", "properties": { "allowPairing": { "type": "boolean", "example": true }, "multiUser": { "type": "boolean", "example": true }, "supervised": { "type": "boolean", "example": true }, "maximumSharedAccounts": { "type": "integer", "example": 10 }, "configureDeviceBeforeSetupAssistant": { "type": "boolean", "example": true }, "names": { "$ref": "#/components/schemas/MobileDevicePrestageNamesV3" }, "sendTimezone": { "type": "boolean", "example": true }, "timezone": { "type": "string", "example": "America/Chicago" }, "storageQuotaSizeMegabytes": { "type": "integer", "example": 4096 }, "useStorageQuotaSize": { "type": "boolean", "example": true }, "temporarySessionOnly": { "type": "boolean", "example": false }, "enforceTemporarySessionTimeout": { "type": "boolean", "example": false }, "temporarySessionTimeout": { "type": "integer", "example": 30 }, "enforceUserSessionTimeout": { "type": "boolean", "example": false }, "userSessionTimeout": { "type": "integer", "example": 30 }, "prestageMinimumOsTargetVersionTypeIos": { "type": "string", "nullable": false, "example": "MINIMUM_OS_LATEST_VERSION", "enum": [ "NO_ENFORCEMENT", "MINIMUM_OS_LATEST_VERSION", "MINIMUM_OS_LATEST_MAJOR_VERSION", "MINIMUM_OS_LATEST_MINOR_VERSION", "MINIMUM_OS_SPECIFIC_VERSION" ] }, "minimumOsSpecificVersionIos": { "minLength": 0, "type": "string", "nullable": false, "example": "17.1" }, "prestageMinimumOsTargetVersionTypeIpad": { "type": "string", "nullable": false, "example": "MINIMUM_OS_LATEST_VERSION", "enum": [ "NO_ENFORCEMENT", "MINIMUM_OS_LATEST_VERSION", "MINIMUM_OS_LATEST_MAJOR_VERSION", "MINIMUM_OS_LATEST_MINOR_VERSION", "MINIMUM_OS_SPECIFIC_VERSION" ] }, "minimumOsSpecificVersionIpad": { "minLength": 0, "type": "string", "nullable": false, "example": "17.1" }, "rtsEnabled": { "type": "boolean", "example": false }, "rtsConfigProfileId": { "type": "string", "example": "1" }, "preserveManagedApps": { "type": "boolean", "description": "Controls whether managed apps are preserved during Return to Service operations.", "example": false }, "installAppsDuringEnrollment": { "type": "boolean", "description": "Controls whether apps are installed during the enrollment process.", "example": true }, "doNotUseProfileFromBackup": { "type": "boolean", "description": "If true, the device does not use the profile when it restores a backup. Default is false. Available in iOS 26 and later, and visionOS 26 and later; otherwise ignored by devices.", "example": true } } } ] }, "PrestagePurchasingInformationV3": { "required": [ "appleCareId", "id", "leaseDate", "leased", "lifeExpectancy", "poDate", "poNumber", "purchasePrice", "purchased", "purchasingAccount", "purchasingContact", "vendor", "versionLock", "warrantyDate" ], "type": "object", "properties": { "id": { "type": "string", "example": "-1" }, "leased": { "type": "boolean", "example": true }, "purchased": { "type": "boolean", "example": true }, "appleCareId": { "type": "string", "example": "abcd" }, "poNumber": { "type": "string", "example": "53-1" }, "vendor": { "type": "string", "example": "Example Vendor" }, "purchasePrice": { "type": "string", "example": "$500" }, "lifeExpectancy": { "type": "integer", "example": 5 }, "purchasingAccount": { "type": "string", "example": "admin" }, "purchasingContact": { "type": "string", "example": "true" }, "leaseDate": { "type": "string", "example": "2019-01-01" }, "poDate": { "type": "string", "example": "2019-01-01" }, "warrantyDate": { "type": "string", "example": "2019-01-01" }, "versionLock": { "type": "integer", "example": 1 } } } }, "securitySchemes": { "Bearer": { "type": "http", "scheme": "bearer", "bearerFormat": "JWT" }, "BasicAuth": { "type": "http", "description": "Basic auth is used only for obtaining bearer tokens from the /v1/auth/token endpoint", "scheme": "basic" }, "ApiClient": { "type": "oauth2", "description": "Jamf Pro API Roles and Clients provide a client ID and secret for obtaining access tokens using the OAuth2 client_credentials grant type", "flows": { "clientCredentials": { "tokenUrl": "/api/v1/oauth/token", "scopes": {} } } } } } } ```