GET ALL
Query all off hours settings associated with the given customer API key
get
https://api.eyelevel.ai/v1/partner
/offhours/:apiKey
QUERY ALL

Response

{
"offhoursSettings": [
{
"id": "STRING IDENTIFIER",
"hoursId": INTEGER IDENTIFIER,
"name": "STRING",
"settings": [
{
"active": BOOLEAN,
"day": "ENUMERATED STRING",
"end": "TIME STRING",
"start": "TIME STRING"
}
],
"timezone": "IANA TIME ZONE"
}
]
}

id

The unique identifier for the chat flow associated with the off hours setting. This chat flow will run during the time periods defined as active.

hoursId

The unique integer identifier for the off hours setting.

name

The human readable name for the off hours setting.

settings

An array of SETTINGS objects that define when the hours settings are active.

settings.active

Defines whether the hours settings are active for the given day.

settings.day

The day of week that the setting applies to.

settings.end

The time of day when the chat flow associated with the off hours setting will no longer be active. The string is formatted in 24 hour time, including seconds.

settings.start

OPTIONAL - String
Validation: Must be a properly formatted time string
The time of day when the chat flow associated with the off hours setting will become active. The string is formatted in 24 hour time, including seconds.

timezone

The timezone for the off hours settings. The timezone is provided in IANA format.
Copy link
On this page
get
QUERY ALL
Response
id
hoursId
name
settings
settings.active
settings.day
settings.end
settings.start
timezone