Skip to main content
PATCH
/
v1
/
configurations
/
{id}
Edit a configuration
curl --request PATCH \
  --url https://managexrapi.com/v1/configurations/{id} \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "Client Configuration v2",
  "vrContent": [
    {
      "type": "app",
      "id": {
        "packageName": "com.my.customApp",
        "releaseChannel": "prod"
      }
    },
    {
      "type": "video",
      "id": "KSJ34KHDA12MR"
    },
    {
      "type": "app",
      "id": {
        "packageName": "com.my.test1",
        "version": "latest"
      }
    },
    {
      "type": "app",
      "id": {
        "packageName": "com.my.test1",
        "version": {
          "versionCode": 1,
          "versionName": "1.0"
        }
      }
    }
  ],
  "wifiNetworkIds": [
    "1390KJDL139PJD",
    "KAFJ39UT124P98"
  ]
}'
{
  "data": {
    "id": "sFidGmedeQofSBcvRcyn",
    "name": "Education",
    "registrationCode": "f7GbHvH",
    "deviceCount": 15,
    "deviceExperienceMode": "HOME_SCREEN",
    "vrContent": [
      {
        "id": "av_123",
        "type": "managed",
        "configurationDeployments": {
          "config_123": 1,
          "config_456": 0
        },
        "createdAt": 1645615777448,
        "updatedAt": 1687352117203,
        "versionCode": 83894522,
        "versionName": "8.7.8.1206",
        "versionLabel": "Quest",
        "hidden": false,
        "forceInstall": false,
        "apkSize": 72633861,
        "obbSize": 1024,
        "selfHosted": true,
        "apkUrl": "https://storage.example.com/apps/com.example.app.apk",
        "obbUrl": "https://storage.example.com/apps/com.example.app.obb",
        "sharingOrganizationName": "XR Developer",
        "releaseChannelName": "Production",
        "supportedDeviceModels": [
          "Quest 3",
          "Quest 3S",
          "Pico 4 Ultra Enterprise"
        ]
      }
    ],
    "kioskVrContent": {
      "type": "app",
      "id": {
        "packageName": "<string>",
        "releaseChannel": "<string>",
        "type": "shared"
      }
    },
    "kioskVideoSettings": {
      "loopVideo": true,
      "loopVideoAfterNSecondsHeadsetOff": 30
    },
    "files": [
      {
        "id": "DLO133U5NFLMAL1",
        "url": "https://storage.googleapis.com/managexr-files/org_456/files/file_123abc.mp4",
        "name": "main_assets_all.bundle",
        "size": 1204975930,
        "md5": "7ah69cMtXyaz5OfsCRtOjQ==",
        "description": "Content bundle for training app",
        "libraryDirectoryPath": "/",
        "deviceDirectoryPaths": [
          "/Android/obb/com.managexr.exampleApp/files"
        ]
      }
    ],
    "wifiNetworks": [
      {
        "id": "wifi_abc123",
        "ssid": "MyNetwork",
        "nickname": "Office Wi-Fi",
        "type": "WPA_ENTERPRISE"
      }
    ]
  }
}

Authorizations

​
Authorization
string
header
required

API key based authentication where <encoded-value> is the Base64 encoding of API_KEY_ID:API_KEY_SECRET

  • Username: The API Key ID.
  • Password: The API Key Secret.

Path Parameters

​
id
string
required

Unique identifier of the configuration

Query Parameters

​
organizationId
string

Unique identifier of the organization.
Defaults to the organization associated with the API key.

Body

application/json
​
name
string

Updated name for the configuration

Example:

"Client Configuration v2"

​
vrContent
(App (Release Channel) · object | App (Specific Version) · object | Video · object | WebXR Link · object)[]

Updated set of VR content on the configuration. Content will appear on the Home Screen in the order it appears in the vrContent array.

  • App (Release Channel)
  • App (Specific Version)
  • Video
​
kioskVrContent
object

Set the App or video to kiosk devices into.

Requirements:

  • The deviceExperience field must also be set to KIOSK or KIOSK_VIDEO
  • The App or Video must be included in the configurations vrContent already (or in this request)
  • App (Release Channel)
  • App (Specific Version)
  • Video
​
deviceExperienceMode
enum<string>

Device experience

KIOSK is Kiosk App. Options vary by device type. See supported device information here.

Available options:
HOME_SCREEN,
KIOSK,
KIOSK_VIDEO,
DEFAULT
Example:

"HOME_SCREEN"

​
confirmMetaDeviceModeChange
boolean

Only required if deviceExperience change impacts Meta Horizon managed services device mode. Supplying the flag confirms that you understand the risks and requirements of the mode change._

Example:

false

​
wifiNetworkIds
string[]

Unique identifiers of wi-fi networks to deploy on the configuration

​
files
object
Example:
{
  "id": "DLO133U5NFLMAL1",
  "deviceDirectoryPaths": [
    "/Android/obb/com.managexr.exampleApp/files"
  ]
}

Response

The updated configuration

​
data
object

Full representation of a configuration.