Get Blackouts

List all blackout dates for a given team.

Response (Output) Params
ParameterDescription
*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.

Query Params
string
required

Your organization's ID of the team for which you want to retrieve blackouts.

Responses

Language
LoadingLoading…
Response
Choose an example:
application/json