Devices

Updates a device.

Changed on

Notes, the DOOH screen attributes (screen_orientation, is_audio_enabled, is_outdoor) and location.venue_id are applied exactly as supplied, so omitting one or sending null clears it back to "not stated". The other optional fields keep their existing value when omitted.

Venue is set through location.venue_id. The legacy "venue:{id}" tag is deprecated: it is no longer read or written, and tagging a device will not change its venue.

put/devices/{id}

Request

  • Base URL
    https://api.reveldigital.com
  • Auth
    • OAuth 2
      Authorization codehttps://id.reveldigital.com/connect/authorize
      Token URLhttps://id.reveldigital.com/connect/token
      Scopeswebapi
    • or API key in header X-RevelDigital-ApiKey
    • or API key in query parameter api_key
  • TypeScript
    A function with typed inputs. Its response is checked against the schema.

Path parameters

idstring required

Device Id

Request body

namestring nullable

The device name

tagsstring nullable

Tags associated with this device

timeZonestring nullable

The timezone of the device

language_codestring nullable

The language code of the device

group_idstring nullable

The group id

last_servicestring date-time nullable

The last service date

mac_addressstring nullable

The MAC address of this device, is applicable

notesstring nullable

Free-form notes associated with this device.

serial_numberstring nullable

The device serial number

screen_orientationinteger nullable

Degrees of screen rotation. One of 0, 90, 180 or 270. A null value means the orientation is not stated.

is_audio_enabledboolean nullable

Whether the screen can play audible audio. This is distinct from the configured volume: a screen may have a volume set but no speakers, or sit where audio is not permitted. A null value means this is not stated, and is never treated as false.

is_outdoorboolean nullable

Whether the screen is deployed outdoors. A null value means this is not stated, and is never treated as false.

Response

No Content

Changes

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property /

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property