---
title: "Create a power policy"
method: POST
path: "/v1/power-policies"
tags: ["power-policies"]
---

# Create a power policy

`POST /v1/power-policies`

## Request

- Base URL: `https://api.brixsignage.com`
- URL: `https://api.brixsignage.com/v1/power-policies`
- Auth: HTTP bearer

Create a named power policy that defines when screens using it should power on and off.

**Notes.**
- Needs the permission at the workspace root: a location-scoped key is refused.

## Request body

- object
  - `name` string: Default on create: `Untitled policy`.
  - `description` string, nullable
  - `windows` object: Open window per weekday. `null` or an absent day is closed. A malformed day is dropped (closed), not refused.
    - `mon` OpenWindow
      - `start` string, required: Opening time, `HH:MM` 24-hour, local time.
      - `end` string, required: Closing time, `HH:MM`. An `end` at or before `start` runs past midnight.
      - `volume` integer, nullable: Volume 0–100 while open; absent or null keeps the screen's own.
      - `brightness` integer, nullable: Backlight 0–100 while open; absent or null keeps the screen's own.
      - `muted` boolean, nullable: Mute (true) or unmute (false) while open; absent or null keeps the screen's own.
    - `tue` OpenWindow
      - `start` string, required: Opening time, `HH:MM` 24-hour, local time.
      - `end` string, required: Closing time, `HH:MM`. An `end` at or before `start` runs past midnight.
      - `volume` integer, nullable: Volume 0–100 while open; absent or null keeps the screen's own.
      - `brightness` integer, nullable: Backlight 0–100 while open; absent or null keeps the screen's own.
      - `muted` boolean, nullable: Mute (true) or unmute (false) while open; absent or null keeps the screen's own.
    - `wed` OpenWindow
      - `start` string, required: Opening time, `HH:MM` 24-hour, local time.
      - `end` string, required: Closing time, `HH:MM`. An `end` at or before `start` runs past midnight.
      - `volume` integer, nullable: Volume 0–100 while open; absent or null keeps the screen's own.
      - `brightness` integer, nullable: Backlight 0–100 while open; absent or null keeps the screen's own.
      - `muted` boolean, nullable: Mute (true) or unmute (false) while open; absent or null keeps the screen's own.
    - `thu` OpenWindow
      - `start` string, required: Opening time, `HH:MM` 24-hour, local time.
      - `end` string, required: Closing time, `HH:MM`. An `end` at or before `start` runs past midnight.
      - `volume` integer, nullable: Volume 0–100 while open; absent or null keeps the screen's own.
      - `brightness` integer, nullable: Backlight 0–100 while open; absent or null keeps the screen's own.
      - `muted` boolean, nullable: Mute (true) or unmute (false) while open; absent or null keeps the screen's own.
    - `fri` OpenWindow
      - `start` string, required: Opening time, `HH:MM` 24-hour, local time.
      - `end` string, required: Closing time, `HH:MM`. An `end` at or before `start` runs past midnight.
      - `volume` integer, nullable: Volume 0–100 while open; absent or null keeps the screen's own.
      - `brightness` integer, nullable: Backlight 0–100 while open; absent or null keeps the screen's own.
      - `muted` boolean, nullable: Mute (true) or unmute (false) while open; absent or null keeps the screen's own.
    - `sat` OpenWindow
      - `start` string, required: Opening time, `HH:MM` 24-hour, local time.
      - `end` string, required: Closing time, `HH:MM`. An `end` at or before `start` runs past midnight.
      - `volume` integer, nullable: Volume 0–100 while open; absent or null keeps the screen's own.
      - `brightness` integer, nullable: Backlight 0–100 while open; absent or null keeps the screen's own.
      - `muted` boolean, nullable: Mute (true) or unmute (false) while open; absent or null keeps the screen's own.
    - `sun` OpenWindow
      - `start` string, required: Opening time, `HH:MM` 24-hour, local time.
      - `end` string, required: Closing time, `HH:MM`. An `end` at or before `start` runs past midnight.
      - `volume` integer, nullable: Volume 0–100 while open; absent or null keeps the screen's own.
      - `brightness` integer, nullable: Backlight 0–100 while open; absent or null keeps the screen's own.
      - `muted` boolean, nullable: Mute (true) or unmute (false) while open; absent or null keeps the screen's own.
  - `rebootHourLocal` number, nullable: 0–23; rounded and clamped. Null (or a value that is not a number) turns the restart off.
  - `timezone` string, nullable: IANA time zone (`Europe/London`). An unknown zone is refused with 422.

## Response `201`

Success.

- object
  - `data` PowerPolicy, required
    - `id` string, required: Power policy id.
    - `spaceId` string, required
    - `name` string, required
    - `description` string, nullable, required
    - `windows` WeeklyWindows, required: Open window per weekday (`mon` … `sun`). A day that is absent is closed.
      - `mon` OpenWindow
        - `start` string, required: Opening time, `HH:MM` 24-hour, local time.
        - `end` string, required: Closing time, `HH:MM`. An `end` at or before `start` runs past midnight.
        - `volume` integer, nullable: Volume 0–100 while open; absent or null keeps the screen's own.
        - `brightness` integer, nullable: Backlight 0–100 while open; absent or null keeps the screen's own.
        - `muted` boolean, nullable: Mute (true) or unmute (false) while open; absent or null keeps the screen's own.
      - `tue` OpenWindow
        - `start` string, required: Opening time, `HH:MM` 24-hour, local time.
        - `end` string, required: Closing time, `HH:MM`. An `end` at or before `start` runs past midnight.
        - `volume` integer, nullable: Volume 0–100 while open; absent or null keeps the screen's own.
        - `brightness` integer, nullable: Backlight 0–100 while open; absent or null keeps the screen's own.
        - `muted` boolean, nullable: Mute (true) or unmute (false) while open; absent or null keeps the screen's own.
      - `wed` OpenWindow
        - `start` string, required: Opening time, `HH:MM` 24-hour, local time.
        - `end` string, required: Closing time, `HH:MM`. An `end` at or before `start` runs past midnight.
        - `volume` integer, nullable: Volume 0–100 while open; absent or null keeps the screen's own.
        - `brightness` integer, nullable: Backlight 0–100 while open; absent or null keeps the screen's own.
        - `muted` boolean, nullable: Mute (true) or unmute (false) while open; absent or null keeps the screen's own.
      - `thu` OpenWindow
        - `start` string, required: Opening time, `HH:MM` 24-hour, local time.
        - `end` string, required: Closing time, `HH:MM`. An `end` at or before `start` runs past midnight.
        - `volume` integer, nullable: Volume 0–100 while open; absent or null keeps the screen's own.
        - `brightness` integer, nullable: Backlight 0–100 while open; absent or null keeps the screen's own.
        - `muted` boolean, nullable: Mute (true) or unmute (false) while open; absent or null keeps the screen's own.
      - `fri` OpenWindow
        - `start` string, required: Opening time, `HH:MM` 24-hour, local time.
        - `end` string, required: Closing time, `HH:MM`. An `end` at or before `start` runs past midnight.
        - `volume` integer, nullable: Volume 0–100 while open; absent or null keeps the screen's own.
        - `brightness` integer, nullable: Backlight 0–100 while open; absent or null keeps the screen's own.
        - `muted` boolean, nullable: Mute (true) or unmute (false) while open; absent or null keeps the screen's own.
      - `sat` OpenWindow
        - `start` string, required: Opening time, `HH:MM` 24-hour, local time.
        - `end` string, required: Closing time, `HH:MM`. An `end` at or before `start` runs past midnight.
        - `volume` integer, nullable: Volume 0–100 while open; absent or null keeps the screen's own.
        - `brightness` integer, nullable: Backlight 0–100 while open; absent or null keeps the screen's own.
        - `muted` boolean, nullable: Mute (true) or unmute (false) while open; absent or null keeps the screen's own.
      - `sun` OpenWindow
        - `start` string, required: Opening time, `HH:MM` 24-hour, local time.
        - `end` string, required: Closing time, `HH:MM`. An `end` at or before `start` runs past midnight.
        - `volume` integer, nullable: Volume 0–100 while open; absent or null keeps the screen's own.
        - `brightness` integer, nullable: Backlight 0–100 while open; absent or null keeps the screen's own.
        - `muted` boolean, nullable: Mute (true) or unmute (false) while open; absent or null keeps the screen's own.
    - `rebootHourLocal` integer, nullable, required: Hour (0–23, local time) the device restarts each day; null = no scheduled restart.
    - `timezone` string, nullable, required: IANA time zone the windows use; null = each screen's own time zone.
    - `createdAt` string, required: ISO-8601 timestamp (UTC).
    - `updatedAt` string, required: ISO-8601 timestamp (UTC).
    - `deletedAt` string, nullable, required: ISO-8601 timestamp (UTC).
    - `screenCount` integer, required: Screens that use this policy.

## Other responses

- `401`: Missing, expired or revoked bearer token.
- `403`: The token lacks the permission this operation needs (see `x-brix-permission`).
- `422`: Unknown `timezone`.
- `5XX`: Server error. The body carries a `requestId` to quote to support.

---

[API](https://skmtc.dev/brixsignage/apis/brix-api.md) · [All operations](https://skmtc.dev/brixsignage/apis/brix-api/llms.txt) · [OpenAPI document](https://skmtc.dev/brixsignage/apis/brix-api/revisions/02fd3665dc7d?raw)