schedules

Add a block to a schedule

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).
post/v1/schedules/{id}/blocks

Request

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

Path parameters

idstring required

Schedule id.

Request body

refKind'media' | 'playlist' | 'app' | 'layout' | 'creative' | 'signage' required

Required on create.

refIdstring required

Required on create.

labelstring

Default "Block".

daysOfWeekinteger[]

0 = Sunday. Default: every day.

startTimestring

24-hour HH:MM. Default 09:00.

endTimestring

24-hour HH:MM; 24:00 is accepted as midnight. Default 17:00.

priorityinteger

Clamped to 0–1000.

startDatestring nullable

YYYY-MM-DD. Any other value is stored as null.

endDatestring nullable
repeatEveryWeeksinteger

Clamped to 1–52.

screensOffboolean

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.