API Reference
  1. Surfact Platform API
  2. Devices

Update a device

patch
https://api.surfact.com/api/v2.0/devices/

Update a device. Only the fields supplied in the body are changed.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

Object id, or ~label to address it by label.

Body Params
string

The device's key. User-assignable, but a device provisioned by Surfact starts life with a UUID label such as 09b27a43-9601-420c-9017-ebe2e8e262dd.

string
string
tags
array of strings
tags
organization
object

The organization that owns the device. Returned as a nested object; on a write you send it as a key — the organization id or its ~label.

properties
object

Free-form metadata carried alongside the device. Surfact populates keys such as device-serial, certificate, destination, max-temp-threshold and min-temp-threshold, plus underscore-prefixed platform keys (_icon, _color, _device_type, _location_type, _location_variable) and a nested _config descriptor map. A PATCH merges into this object rather than replacing it.

Responses

Updated 3 months ago

Did this page help you?
Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 3 months ago

Did this page help you?