Publish Device

POST /devices/{id}/publish

Publishes to a single device. Triggers a soft-reload of the running playlist.

Authentication

Set the Authorization header to Bearer {API Key}.

Scopes: device:publish

Path Parameters

ParameterDescription
idThe device ID to publish to. In most cases this will be the mac address of the device (ie. c4:23:60:91:c0:6c).

Responses

200 (OK)

The device was successfully published.

FieldDescription
published_at  stringThe updated timestamp of the new publish to the device.
{
  "published_at": "2024-12-04T21:02:08.199753Z"
}

204 (No Content)

The device does not have a playlist assigned and the publish was ignored.

FieldDescription
published_at  stringThe timestamp of the most recent publish to the device. If the device has never been published to then null will be returned. .
{
  "published_at": null
}

404 (Not Found)

The device does not exist or the provided API key does not have access to this device. The user that the API key is associated with must have update or publish access to the device.

{
  "message": "Device not found"
}

403 (Forbidden)

The API key does not have the device:publish scope.

{
  "message": "Invalid scopes"
}

Next Steps


Was this article helpful to you?
GitHubProvide feedback

Last edited on January 28, 2025.
GitHubEdit this page