GuidesAPI Reference
Log In
API Reference

Create Blackout

Blackouts will temporarily override schedules set by Delivery Slots, temporarily pausing fulfillment for holidays or during extreme weather events.

Response (Output) Params

Body Params
string
required

The name of the blackout.

date-time
required

The time when the blackout should take effect.

date-time
required

The time when the blackout should end.

string

If this blackout only applies to a specific team, include your organization's ID of that team.

boolean
Defaults to false

Set to true if this blackout should recur annually.

string

If the blackout only applies for a specific service plan, include the external ID of that service plan.

service_area_ids
array of int32s

If the blackout only applies in certain areas, include a list of the Bringg IDs for each of the applicable service areas.

service_area_ids
Responses

Language
Response
Choose an example:
application/json