--- updatedAt: 2026-05-13T14:45:03.000Z agentTools: projectIndex: https://developers.bringg.com/llms.txt --- # Create Blackout Blackouts will temporarily override schedules set by Delivery Slots, temporarily pausing fulfillment for holidays or during extreme weather events.
Response (Output) Params
**Parameter** **Description**
\*`success`\*\*
boolean 		Indicates whether the service completed successfully. * *false*\* - the service failed. * *true*\* - the service succeeded
\*`message`\*\*
string 		If an error occurred, a message indicating the error is included.
\*`rc`\*\*
integer 		If an error occurred, the return code is included.
\*`end_time`\*\*
datetime 		The timestamp when the blackout should end. This is in UTC and the format is "%Y-%m-%dT%H:%M:%S%z".
\*`exclusion_type`\*\*
integer
\*`id`\*\*
integer 		The Bringg ID for this blackout.
\*`merchant_id`\*\*
int32 		The ID of the merchant to which this blackout belongs.
\*`name`\*\*
string 		The name of the blackout.
\*`repeat`\*\*
boolean 		Flag that indicates whether this blackout should recur annually.
\*`service_area_ids`\*\*
array 		The specific areas (Bringg IDs) to which this blackout applies.
\*`service_plan_id`\*\*
int32 		The specific service plan to which this blackout applies.
\*`src_id`\*\*
int32
\*`start_time`\*\*
datetime 		The timestamp when the blackout should take effect. This is in UTC and the format is "%Y-%m-%dT%H:%M:%S%z".
\*`tasks_count`\*\*
int32
\*`tasks_limit`\*\*
int32
\*`team_id`\*\*
int32 		The specific team to which this blackout applies.

# OpenAPI definition ```json { "openapi": "3.1.0", "info": { "title": "services-api-settings", "version": "1.0" }, "servers": [ { "url": "https://developer-api.bringg.com/services" } ], "security": [ {} ], "paths": { "/cewtm30l/{service_uuid1}/{service_uuid2}": { "post": { "summary": "Create Blackout", "description": "Blackouts will temporarily override schedules set by Delivery Slots, temporarily pausing fulfillment for holidays or during extreme weather events.", "operationId": "create_exclusion_window", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "name", "start_time", "end_time" ], "properties": { "name": { "type": "string", "description": "The name of the blackout." }, "external_team_id": { "type": "string", "description": "If this blackout only applies to a specific team, include your organization's ID of that team." }, "service_plan_external_id": { "type": "string", "description": "If the blackout only applies for a specific service plan, include the external ID of that service plan." }, "service_area_ids": { "type": "array", "description": "If the blackout only applies in certain areas, include a list of the Bringg IDs for each of the applicable service areas.", "items": { "type": "integer", "format": "int32" } }, "start_time": { "type": "string", "description": "The time when the blackout should take effect.", "format": "date-time" }, "end_time": { "type": "string", "description": "The time when the blackout should end.", "format": "date-time" }, "repeat": { "type": "boolean", "description": "Set to true if this blackout should recur annually.", "default": false } } }, "examples": { "Annual Recurring Holiday - All Teams": { "value": { "name": "New Years Day", "start_time": "2025-01-01T00:00:00.000Z", "end_time": "2025-01-01T23:59:59.999Z", "repeat": true } }, "Blackout for Team, Service Area, and Service Plan": { "value": { "name": "NYC Marathon Closure", "start_time": "2025-01-25T10:00:00.000Z", "end_time": "2025-01-25T16:59:59.999Z", "external_team_id": "Store 187", "service_plan_external_id": "Express", "service_area_ids": [ 123, 147, 165 ] } } } } } }, "responses": { "200": { "description": "200", "content": { "application/json": { "examples": { "Result": { "value": "{\n \"success\": true,\n \"rc\": 0,\n \"exclusion_window\": {\n \"id\": 1971,\n \"merchant_id\": 1,\n \"team_id\": null,\n \"start_time\": \"2023-01-01T00:00:00.000Z\",\n \"end_time\": \"2023-01-01T23:59:59.999Z\",\n \"name\": \"New Year's Day\",\n \"repeat\": true,\n \"service_plan_id\": null,\n \"src_id\": null,\n \"service_area_ids\": []\n }\n}" } }, "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": true, "default": true }, "rc": { "type": "integer", "example": 0, "default": 0 }, "exclusion_window": { "type": "object", "properties": { "id": { "type": "integer", "example": 1971, "default": 0 }, "merchant_id": { "type": "integer", "example": 1, "default": 0 }, "team_id": {}, "start_time": { "type": "string", "example": "2023-01-01T00:00:00.000Z" }, "end_time": { "type": "string", "example": "2023-01-01T23:59:59.999Z" }, "name": { "type": "string", "example": "New Year's Day" }, "repeat": { "type": "boolean", "example": true, "default": true }, "service_plan_id": {}, "src_id": {}, "service_area_ids": { "type": "array" } } } } } } } }, "400": { "description": "400", "content": { "application/json": { "examples": { "External Team Not Found": { "value": "{\n \"success\": false,\n \"rc\": 22,\n \"message\": \"external_team_id: TEAM123 not found\"\n}" }, "Missing Required Parameter": { "value": "{\n \"success\": false,\n \"rc\": 26,\n \"message\": \"Missing required parameter: start_time\"\n}" }, "Service Plan Not Found": { "value": "{\n \"success\": false,\n \"rc\": 21,\n \"message\": \"service_plan_external_id: yellow not found\"\n}" } }, "schema": { "oneOf": [ { "title": "External Team Not Found", "type": "object", "properties": { "success": { "type": "boolean", "example": false, "default": true }, "rc": { "type": "integer", "example": 22, "default": 0 }, "message": { "type": "string", "example": "external_team_id: TEAM123 not found" } } }, { "title": "Missing Required Parameter", "type": "object", "properties": { "success": { "type": "boolean", "example": false, "default": true }, "rc": { "type": "integer", "example": 26, "default": 0 }, "message": { "type": "string", "example": "Missing required parameter: start_time" } } }, { "title": "Service Plan Not Found", "type": "object", "properties": { "success": { "type": "boolean", "example": false, "default": true }, "rc": { "type": "integer", "example": 21, "default": 0 }, "message": { "type": "string", "example": "service_plan_external_id: yellow not found" } } } ] } } } } }, "deprecated": false } } }, "x-readme": { "headers": [], "explorer-enabled": false, "proxy-enabled": false }, "x-readme-fauxas": true } ```