schedules

Create a schedule

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.
post/v1/schedules

Request

  • Base URL: https://api.brixsignage.com
  • URL: https://api.brixsignage.com/v1/schedules
  • Auth: HTTP bearer

Request body

namestring required

Required.

nodeIdstring

Home location. Default: the caller's own location.

fallbackNamestring
fallbackContentKind'media' | 'playlist' | 'app' | 'layout' | 'creative' | 'signage'
fallbackContentIdstring
fallbackMode'content' | 'off'
playsSolelyboolean
timeBasis'device' | 'cms'
startsAtstring nullable

YYYY-MM-DD or ISO-8601.

expiresAtstring nullable

YYYY-MM-DD or ISO-8601.

Response

Success.

Example response

{
  "data": {
    "id": "sch_6f7a8b9c0d1e2f3a",
    "blocks": [
      {
        "id": "sb_3c4d5e6f7a8b9c0d"
      }
    ]
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.