---
title: Blackouts
description: "### Lookup Data | Conflict Action | Details | | --- | --- | | delete | Delete any conflicting reservations | | skipConflicts | Skip any conflicting reservation times, create blackouts when no conflict | | reject | Do…"
url: "https://www.bookedscheduler.com/help/api/blackouts/"
updated: "2025-09-11"
category: API
---

# Blackouts

### Lookup Data

| Conflict Action | Details |
| --- | --- |
| delete | Delete any conflicting reservations |
| skipConflicts | Skip any conflicting reservation times, create blackouts when no conflict |
| reject | Do not create the blackout |

| Type | Details |
| --- | --- |
| daily | Recur every day until termination date |
| weekly | Recur weekly on the requested week days |
| monthly | Recur monthly using the requested monthly recurrence type (see below) |
| yearly | Recur yearly on the same date |
| none | No recurrence |

| Type | Details |
| --- | --- |
| dayOfMonth | The date of the month (the 12th of each month) |
| dayOfWeek | The weekday of the week of the month (the 3rd Wednesday of each month) |

### GET Methods

#### Get All Blackouts

 Description Returns all blackouts matching the search criteria. Query String Parameters   Name Description     resourceId Id of resource to get blackouts for.   scheduleId Id of schedule to get blackouts for.   startDateTime Earliest datetime to get blackout times for (inclusive). If no dates are provided, blackouts for the next two weeks will be returned.   endDateTime Latest datetime to get blackout times for (inclusive). If no dates are provided, blackouts for the next two weeks will be returned.   If dates do not include the timezone offset, the timezone of the authenticated user will be assumed. Route /Blackouts Authentication This service is secure and requires authentication headers This service is only available to application administrators Example Response `{
    "blackouts": [
        {
            "id": 10,
            "seriesId": 100,
            "startDateTime": "2025-09-10T21:04:22-0400",
            "endDateTime": "2025-09-10T21:04:22-0400",
            "resourceId": 1,
            "reason": "blackout reason"
        }
    ]
    "links": [],
    "message": null
}`

#### Get Blackouts

 Description Returns blackout by series id Route /Blackouts/:seriesId Authentication This service is secure and requires authentication headers This service is only available to application administrators Example Response `{
    "id": 1,
    "dates": [
        {
            "startDateTime": "2025-09-10T21:04:22-0400",
            "endDateTime": "2025-09-10T21:04:22-0400"
        }
    ],
    "resourceIds": [
        10,
        100
    ],
    "recurrenceRule": {
        "type": "daily|monthly|none|weekly|yearly",
        "interval": 3,
        "monthlyType": "dayOfMonth|dayOfWeek|null",
        "weekdays": [
            0,
            1,
            2,
            3,
            4,
            5,
            6
        ],
        "repeatTerminationDate": "2025-09-10T21:04:22-0400",
        "repeatDates": [
            "2025-09-10T21:04:22-0400"
        ]
    }
}`

### POST Methods

#### Create Blackout

 Description Creates a new blackout. Route /Blackouts/ Authentication This service is secure and requires authentication headers This service is only available to application administrators Example Request `{
    "reason": "blackout reason",
    "startDateTime": "2025-09-10T21:04:22-0400",
    "endDateTime": "2025-09-10T21:04:22-0400",
    "resourceIds": [
        1,
        2,
        3
    ],
    "conflictAction": "delete | skipConflicts | reject",
    "recurrenceRule": {
        "type": "daily|monthly|none|weekly|yearly",
        "interval": 3,
        "monthlyType": "dayOfMonth|dayOfWeek|null",
        "weekdays": [
            0,
            1,
            2,
            3,
            4,
            5,
            6
        ],
        "repeatTerminationDate": "2025-09-10T21:04:22-0400",
        "repeatDates": [
            "2025-09-10T21:04:22-0400"
        ]
    }
}` Example Response `"dates": [
        {
            "startDateTime": "2025-09-10T21:04:22-0400",
            "endDateTime": "2025-09-10T21:04:22-0400"
        }
    ],
    "resourceIds": [
        10,
        100
    ],
    "recurrenceRule": {
        "type": "daily|monthly|none|weekly|yearly",
        "interval": 3,
        "monthlyType": "dayOfMonth|dayOfWeek|null",
        "weekdays": [
            0,
            1,
            2,
            3,
            4,
            5,
            6
        ],
        "repeatTerminationDate": "2025-09-10T21:04:22-0400",
        "repeatDates": [
            "2025-09-10T21:04:22-0400"
        ]
    }`

#### Update Blackout

 Description Updates an existing blackout. Route /Blackouts/:seriesId Authentication This service is secure and requires authentication headers This service is only available to application administrators Example Request `{
    "reason": "blackout reason",
    "startDateTime": "2025-09-10T21:04:22-0400",
    "endDateTime": "2025-09-10T21:04:22-0400",
    "resourceIds": [
        1,
        2,
        3
    ],
    "conflictAction": "delete | skipConflicts | reject",
    "recurrenceRule": {
        "type": "daily|monthly|none|weekly|yearly",
        "interval": 3,
        "monthlyType": "dayOfMonth|dayOfWeek|null",
        "weekdays": [
            0,
            1,
            2,
            3,
            4,
            5,
            6
        ],
        "repeatTerminationDate": "2025-09-10T21:04:22-0400",
        "repeatDates": [
            "2025-09-10T21:04:22-0400"
        ]
    }
}` Example Response `"dates": [
        {
            "startDateTime": "2025-09-10T21:04:22-0400",
            "endDateTime": "2025-09-10T21:04:22-0400"
        }
    ],
    "resourceIds": [
        10,
        100
    ],
    "recurrenceRule": {
        "type": "daily|monthly|none|weekly|yearly",
        "interval": 3,
        "monthlyType": "dayOfMonth|dayOfWeek|null",
        "weekdays": [
            0,
            1,
            2,
            3,
            4,
            5,
            6
        ],
        "repeatTerminationDate": "2025-09-10T21:04:22-0400",
        "repeatDates": [
            "2025-09-10T21:04:22-0400"
        ]
    }`

### DELETE Methods

#### Delete Blackout

 Description Deletes an existing blackout. Route /Blackouts/:seriesId Authentication This service is secure and requires authentication headers This service is only available to application administrators Example Request No request body Example Response `{
    "links": [],
    "message": "The item was deleted"
}`