TRMNL Octri Demo
PATCH/api/apps/fleet/{installation_id}/settings

Update fleet inherited settings

Updates the list of settings that fleet mirrors inherit from the master. Each push copies the selected settings, while an empty list copies only the playlist. Replace the full list with inherited_settings on each request.

  • IdempotentThe SDK sends Idempotency-Key, so a retried request is only applied once.

1 parameter · 1 body field
installation_idstringrequired
The identifier of the fleet installation whose inherited settings to update.

The replacement list of settings that mirrors inherit from the master.

inherited_settingsarray<string>required
The settings to copy from the master on each push: `refresh_interval`, `orientation`, `sleep`, or `palette`.

4 status codes
200Returns the updated fleet data, including its inherited settings, master, mirror count, and push status.
dataobjectoptional
401Returned when the request is unauthorized.
errorstringoptional
404Returned when the installation belongs to another user.
422Returned when the list includes a setting that cannot be inherited.

Error handling

A 401 is returned when the request is unauthorized. A 404 is returned when the installation belongs to another user. A 422 is returned when a setting cannot be inherited. The installation_id path parameter must identify a fleet installation, and inherited_settings is required and can contain only refresh_interval, orientation, sleep, or palette.