schedules

Update a schedule

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.

patch/v1/schedules/{id}

Request

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

Path parameters

idstring required

Schedule id.

Request body

namestring

Required.

nodeIdstring nullable

Move to another location (needs schedule.edit there too).

fallbackNamestring
fallbackContentKind'media' | 'playlist' | 'app' | 'layout' | 'creative' | 'signage' nullable
fallbackContentIdstring nullable
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 2 revisions of this API.