API : FlexCare : App whitelist : Create

Introduction

This will whitelist an app.

This whitelist is used to determine which apps can be assigned to a tablet profile.

Request

URL	https://api.telecomx.dk/flexcare/appwhitelist
Method	POST
Access level	ADMIN, or RESELLER admin with the TV employee feature
body	packageName	String	`[required]` Android package name for the app
	name	String	`[required]` App name
	description	String	`[optional]` App description. Default empty.
	icon	ObjectId	`[optional]` Id of the icon image. Default null.
	iconUrl	String	`[optional]` Default icon url, used for having a default icon for tablet profile
	private	Boolean	`[optional]` Should be set if app is not in an app store. Default false.
	whitelistOnly	Boolean	`[optional]` True if app should not be installed nor validated for correct version. Default false.
	autoUpdateDefault	Boolean	`[optional]` Used to tell the automatic version fetcher that it should move the default flag to the newest version when one is found. Default false.
	androidTV	Boolean	`[optional]` Used to tell the automatic version fetcher that it should find the Android TV version of the application. Default false.
	minimumVersion	Number	`[optional]` Minimum build version wanted. Default 0.
	apks	Array	`[optional]` List of APK versions to add. Default empty. `_id` and `releaseDate` must NOT be sent — they are assigned by the server.
	apks[].version	String	`[required]` App version
	apks[].versionCode	Number	`[required]` Android version code (build number)
	apks[].file	ObjectId	`[required]` File id of the APK (may be null)
	apks[].default	Boolean	`[optional]` True if this is chosen as the default version of the app. Default false.
	apks[].minAndroidVersion	Number	`[optional]` Minimum Android version required for this APK. Default 0.
	apks[].notes	String	`[optional]` Release notes for this version. Default empty.
	apks[].bundle	Array	`[optional]` Additional files bundled with the APK
	apks[].bundle[].file	ObjectId	`[required]` Unique id of the bundle file
	apks[].bundle[].url	String	`[required]` Url where file is located
	customerWhitelist	Array	`[optional]` Array of customer IDs (ObjectIds). If the list is empty, then the app is allowed to be added to all tablet profiles. If it's not empty, then the customers added to this list are the only ones allowed to use this app. Note that if a reseller is added to this list, then all of their customers are also allowed to access this app. Default empty.

Query examples

https://api.telecomx.dk/flexcare/appwhitelist

Body example

{
  packageName: "com.fitnessapps.marafun",
  name: "MaraFUN",
  icon: "1234567890ABCD1234567890",
  iconUrl: "https://fitnessapps.com/img/marafun200x200.png",
  private: false,
  whitelistOnly: false,
  autoUpdateDefault: true,
  androidTV: false,
  minimumVersion: 0,
  apks: [
    {
      version: "1.0",
      versionCode: 100,
      default: true,
      minAndroidVersion: 8,
      file: "4434567890ABCD1234567980",
      notes: "",
      bundle: [
        {
          file: "1234567890ABCD1234657890",
          url: "https://doc.telecomx.dk/1234567890ABCD1234657890"
        }
      ]
    }
  ],
  customerWhitelist: []
}

Response

The created app is returned in full, with the server-assigned _id and, for each APK, a server-assigned _id and releaseDate.

JSON object
_id	ObjectId	Unique id of the app (generated by the server)
packageName	String	Android package name
name	String	App name
description	String	App description
icon	ObjectId	Id of the icon image (null if none)
iconUrl	String	Icon URL (present only if supplied on create; it is not derived from `icon`)
private	Boolean	Should be set if app is not in an app store
whitelistOnly	Boolean	True if app should not be installed nor validated for correct version
autoUpdateDefault	Boolean	Used to tell the automatic version fetcher that it should move the default flag to the newest version when one is found
androidTV	Boolean	Used to tell the automatic version fetcher that it should find the Android TV version of the application
minimumVersion	Number	Minimum build version wanted
apks	Array	List of APKs for different versions of this app
apks[]._id	ObjectId	Unique object id of the APK (generated by the server)
apks[].version	String	App version
apks[].versionCode	Number	Android version code (build number)
apks[].default	Boolean	True if this is chosen as the default version of the app
apks[].minAndroidVersion	Number	Minimum Android version required for this APK
apks[].file	ObjectId	File id of the APK (null if none)
apks[].notes	String	Release notes for this version
apks[].releaseDate	Date	Set by the server to the time the app was created
apks[].bundle	Array	Array of files from apk bundle
apks[].bundle[].file	ObjectId	Unique id of the bundle file
apks[].bundle[].url	String	Url where file is located
customerWhitelist	Array	Array of customer IDs (ObjectIds). If the list is empty, then the app is allowed to be added to all tablet profiles. If it's not empty, then the customers added to this list are the only ones allowed to use this app. Note that if a reseller is added to this list, then all of their customers are also allowed to access this app.

Example

{
  _id: "ABCDEF1234567890ABCDEF12",
  packageName: "com.fitnessapps.marafun",
  name: "MaraFUN",
  description: "",
  icon: "1234567890ABCD1234567890",
  iconUrl: "https://fitnessapps.com/img/marafun200x200.png",
  private: false,
  whitelistOnly: false,
  autoUpdateDefault: true,
  androidTV: false,
  minimumVersion: 0,
  apks: [
    {
      _id: "1234567890ABCD1234657890",
      version: "1.0",
      versionCode: 100,
      default: true,
      minAndroidVersion: 8,
      file: "4434567890ABCD1234567980",
      notes: "",
      releaseDate: "2026-06-04T12:00:00.000Z",
      bundle: [
        {
          file: "1234567890ABCD1234657890",
          url: "https://doc.telecomx.dk/1234567890ABCD1234657890"
        }
      ]
    }
  ],
  customerWhitelist: []
}

Errors

Error code	Message	Description
422	<field>	Invalid or missing body field (e.g. `packageName`, `name`, `apks[].version`, `apks[].versionCode`, `apks[].file`).
403	access_denied	Insufficient access level, or the reseller admin lacks the TV employee feature.
500	internal_error	<Unspecified>

WIKI

Table of Contents