Change devices
AccountDevicesWriteToolClaim an unclaimed device, change a device's settings, flash its screen to identify it, mirror another device's sharable playlist onto it, or retry a stalled firmware update. clearDevicePlaylist is destructive; stopMirroringDevice is a DELETE but only clears the mirror link, not any data.
claimDevice: Claim an unclaimed device — params: friendly_id (body: The code shown on the device during setup)
updateDevice: Update a device — params: id (path), name (body), refresh_interval (body: Seconds between check-ins, 300 to 86400), orientation (body), sleep_mode_enabled (body), sleep_screen_enabled (body), sleep_start_time (body: Minutes after midnight, 0 to 1439), sleep_end_time (body: Minutes after midnight, 0 to 1439), sleep_until (body: Sleep once, from the next check-in until this ISO 8601 time (at most a year out); no offset means the account time zone, null cancels. Any later check-in, such as a button press, wakes the device), ota_enabled (body), low_battery_notification_enabled (body), low_battery_notification_email (body), low_battery_screen_disabled (body), percent_charged (body), visibility (body: one of standalone, sharable), model_id (body: listModels; a BYOD device can take any model), firmware_channel (body: one of development, test, staging, production), special_function (body), touchbar_mode (body: one of tap, swipe), temperature_profile (body: one of default, a, b), waits_for_next_render (body), refreshing_screen_disabled (body), maximum_compatibility (body), guest_mode_item_id (body), guest_mode_item_duration (body), palette_id (body: listPalettes), font_family (body), text_scale (body: one of small, regular, large, xlarge), theme (body), auto_advance (body: Beta: may change or go away. false keeps the current screen until a button press; taken only when management.writable_fields lists it), playlist_item_ttl (body: one of 24, 48, 72, 96, 120, 144, 168), custom_width (body: byod_custom model only), custom_height (body: byod_custom model only), custom_format (body: byod_custom model only), framework_size (body: one of sm, md, lg), maximum_image_bytes (body: byod_custom model only), dither_pixel_ratio (body: byod_custom model only), scale_factor (body: BYOD only), ui_scale (body: BYOD only), rotate (body)
identifyDevice: Identify a device — params: device_id (path)
clearDevicePlaylist: Clear a device playlist — params: device_id (path)
mirrorDevice: Point a device at another device's shared playlist — params: device_id (path), master_friendly_id (body: friendly_id of the sharable device to mirror)
stopMirroringDevice: Stop mirroring — params: device_id (path)
resyncDeviceMirror: Resync a mirrored device with its master — params: device_id (path)
retryDeviceFirmwareUpdate: Retry a stalled firmware update — params: device_id (path)
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| action | Yes | The API operation to run | |
| params | No | The operation's path, query and body parameters by name |