Schedules API

GET/v1/schedules

List the workspace's schedules, including their dayparting blocks.

curl "https://api.brixsignage.com/v1/schedules" \
  -H "Authorization: Bearer $BRIX_API_KEY"

Response 200 Success.

Response 401 Missing, expired or revoked bearer token.

Response 403 The token lacks the permission this operation needs (see `x-brix-permission`).

Response 5XX Server error. The body carries a `requestId` to quote to support.

POST/v1/schedules

Create a schedule with a name and an optional nodeId and other fields. Safe to retry with an idempotency key. Creates an empty schedule. Add its dayparts with POST /v1/schedules/{id}/blocks, then assign it to screens. **Notes.** - Create returns the stored row plus blocks: [], not the composed schedule the other schedule routes return: no usedByScreenCount, fallbackContentRef, fallbackThumbnailUrl, recalledAt, approvedSnapshot or importSourceId.

Request body application/json

curl -X POST "https://api.brixsignage.com/v1/schedules" \
  -H "Authorization: Bearer $BRIX_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name":"Weekday dayparts","fallbackContentKind":"playlist","fallbackContentId":"pl_2a3b4c5d6e7f8a9b","startsAt":"2026-10-01"}'

Response 201 Success.

{
  "data": {
    "id": "sch_6f7a8b9c0d1e2f3a",
    "spaceId": "space_1a2b3c4d5e6f7a8b",
    "nodeId": null,
    "name": "Weekday dayparts",
    "fallbackName": "Default Loop",
    "fallbackContentKind": "playlist",
    "fallbackContentId": "pl_2a3b4c5d6e7f8a9b",
    "fallbackMode": "content",
    "playsSolely": false,
    "timeBasis": "device",
    "startsAt": "2026-10-01",
    "expiresAt": null,
    "approvalState": "draft",
    "createdAt": "2026-09-28T09:00:00.000Z",
    "updatedAt": "2026-09-28T09:00:00.000Z",
    "deletedAt": null,
    "blocks": []
  }
}

Response 401 Missing, expired or revoked bearer token.

Response 403 `not_shared`: the fallback content is not shared to the schedule's location.

Response 404 The fallback content or location does not exist in this workspace.

Response 422 `name` missing, or an unparseable `startsAt` / `expiresAt`.

Response 5XX Server error. The body carries a `requestId` to quote to support.

GET/v1/schedules/{id}

Retrieve one schedule, including its ordered blocks, with each block's time window, recurrence, content reference, and priority.

curl "https://api.brixsignage.com/v1/schedules/{id}" \
  -H "Authorization: Bearer $BRIX_API_KEY"

Response 200 Success.

Response 401 Missing, expired or revoked bearer token.

Response 403 The token lacks the permission this operation needs (see `x-brix-permission`).

Response 404 No such schedule in this workspace.

Response 5XX Server error. The body carries a `requestId` to quote to support.

PATCH/v1/schedules/{id}

Edit a schedule's own fields, such as name, node, timezone, and default behaviour. Blocks are managed through the separate /blocks routes. Partial update of schedule-level fields. A playback change to an approved schedule returns it to draft.

Request body application/json

curl -X PATCH "https://api.brixsignage.com/v1/schedules/{id}" \
  -H "Authorization: Bearer $BRIX_API_KEY" \
  -H "Content-Type: application/json"

Response 200 Success.

Response 401 Missing, expired or revoked bearer token.

Response 403 Moving to a location you cannot edit, or fallback content not shared there.

Response 404 No such schedule, fallback content or location.

Response 422 Unparseable `startsAt` / `expiresAt`.

Response 5XX Server error. The body carries a `requestId` to quote to support.

DELETE/v1/schedules/{id}

Delete a schedule to the recycle bin. Screens using it fall back to their assigned content. Soft-deletes into the recycle bin. Screens on it fall back to their other content.

curl -X DELETE "https://api.brixsignage.com/v1/schedules/{id}" \
  -H "Authorization: Bearer $BRIX_API_KEY"

Response 200 Success.

Response 401 Missing, expired or revoked bearer token.

Response 403 The token lacks the permission this operation needs (see `x-brix-permission`).

Response 404 No such schedule.

Response 409 `content_shared`: the schedule is shared; the body carries `shareCount`. Retry with `?force=true`.

Response 5XX Server error. The body carries a `requestId` to quote to support.

POST/v1/schedules/{id}/blocks

Add one dayparting block to a schedule with refKind, refId, days, startTime, endTime, and an optional priority and other fields. **Notes.** - The returned schedule is composed from the row read BEFORE the edit, so approvalState / updatedAt can lag the edit by one read (the blocks are current).

Request body application/json

curl -X POST "https://api.brixsignage.com/v1/schedules/{id}/blocks" \
  -H "Authorization: Bearer $BRIX_API_KEY" \
  -H "Content-Type: application/json"

Response 201 Success.

Response 401 Missing, expired or revoked bearer token.

Response 403 `not_shared`: the content is not shared to the schedule's location.

Response 404 No such schedule, or the content does not exist in this workspace.

Response 422 Missing `refKind`/`refId`, or a malformed time.

Response 5XX Server error. The body carries a `requestId` to quote to support.

PATCH/v1/schedules/{id}/blocks/{blockId}

Edit one dayparting block's time window, days, priority, or content reference. Partial: omitted fields keep their stored value. **Notes.** - The returned schedule is composed from the row read BEFORE the edit, so approvalState / updatedAt can lag the edit by one read (the blocks are current).

Request body application/json

curl -X PATCH "https://api.brixsignage.com/v1/schedules/{id}/blocks/{blockId}" \
  -H "Authorization: Bearer $BRIX_API_KEY" \
  -H "Content-Type: application/json"

Response 200 Success.

Response 401 Missing, expired or revoked bearer token.

Response 403 `not_shared`: the content is not shared to the schedule's location.

Response 404 No such schedule or block.

Response 422 A malformed time.

Response 5XX Server error. The body carries a `requestId` to quote to support.

DELETE/v1/schedules/{id}/blocks/{blockId}

Remove one dayparting block from a schedule. Removes the block (a hard delete of the child row) and re-packs positions. **Notes.** - The returned schedule is composed from the row read BEFORE the edit, so approvalState / updatedAt can lag the edit by one read (the blocks are current). - An unknown blockId is not an error: the route answers 200 with the unchanged schedule.

curl -X DELETE "https://api.brixsignage.com/v1/schedules/{id}/blocks/{blockId}" \
  -H "Authorization: Bearer $BRIX_API_KEY"

Response 200 Success.

Response 401 Missing, expired or revoked bearer token.

Response 403 The token lacks the permission this operation needs (see `x-brix-permission`).

Response 404 No such schedule.

Response 5XX Server error. The body carries a `requestId` to quote to support.

POST/v1/schedules/{id}/restore

Restore a deleted schedule so its block layout returns to the schedule library.

curl -X POST "https://api.brixsignage.com/v1/schedules/{id}/restore" \
  -H "Authorization: Bearer $BRIX_API_KEY"

Response 4XX Client error. 404 rather than 403 for another tenant's resource, so account existence is not leaked.

Response 5XX Server error. The body carries a `requestId` to quote to support.