APIs & SDKs

Patch

patch
https://api.formant.io/v1/admin/devices/

Update an existing device. Resource: devices Authorized roles: administrator, device

Path Params
string
required
Body Params

PartialDevice

uuid

ID of the organization which contains this device.

string | null

External ID of this device.

string

Name of this device.

string | null

Description of this device.

string
enum

Enter default.

Allowed:
uuid | null

ID of the user associated with this device.

uuid | null

ID of the fleet with which this device is associated.

string
scope
object | null

Currently unused, ignore.

deviceScope
object

Currently unused, ignore.

string | null

Agent version you want to install if different from the latest version. Must have formant-sidecar installed.

int64 | null
1 to 9007199254740991

Device configuration version you want to apply. Ignore for new device configuration.

int64 | null
1 to 9007199254740991
date-time | null
uuid | null
muted
object | null

Set this to temporarily mute notifications for this device.

followers
array of objects
length ≤ 10

Users who receive SMS updates from this device.

followers
slackChannels
array of strings

Slack channels which receive updates from this device.

slackChannels
state
object
boolean
boolean
date-time | null
uuid
date-time
date-time
tags
object
Response

Updated 5 months ago

Language
Credentials
Bearer
JWT
Response 
Click Try It! to start a request and see the response here! Or choose an example:
application/json
Updated 5 months ago