Skip to content

Set a tile icon for a device
Stable

Request

Applies a tile icon to one or more devices, groups, or a device model. Once used for ealirer versions of the Blueprints experience.

Sets the specified icon as the tile icon for the target scope, determined by apply_mode — individual devices, all devices, device groups, or all devices of a given model.

About Device Tile Icons This endpoint controls how an icon is scoped when applied — a single call can update a specific list of devices, every device in one or more groups, every device of a given model, or the entire fleet, depending on apply_mode.

Security
esper_cloud_api_apiKey
Path
enterprise_idstringrequired

A UUID string identifying this enterprise.

Bodyapplication/jsonrequired
iconstring or null, (uuid)
apply_modestring
Default:"devices"
Enum:"devices""all_devices""groups""device_model"
device_modelstring or null
devicesArray of any, (string)
groupsArray of strings
cURL
curl -i -X POST \
  'https://develop-api.esper.io/_mock/openapi/v1/enterprise/{enterprise_id}/tile-icon-apply/' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "icon": "bc9b3dc5-578a-4929-a13c-7d1a9725e2b0",
    "apply_mode": "devices",
    "device_model": "string",
    "devices": [
      null
    ],
    "groups": [
      "string"
    ]
  }'

Responses

Successful Operation

Bodyapplication/json
iconstring or null, (uuid)
apply_modestring
Default:"devices"
Enum:"devices""all_devices""groups""device_model"
device_modelstring or null
devicesArray of any, (string)
groupsArray of strings
Response
{
  "icon": "bc9b3dc5-578a-4929-a13c-7d1a9725e2b0",
  "apply_mode": "devices",
  "device_model": "string",
  "devices": [
    null
  ],
  "groups": [
    "string"
  ]
}