API Reference

Create a Calendar

post
https://api.naxai.com/calendars

Create a new calendar.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
required

The name of the calendar.

string

The timezone to use, by default Europe/Brussels

schedule
array of objects
required
length between 7 and 7

The 7 days of the week with opening parameters.

schedule*
integer
1 to 7

The day of the week (1=Monday ... 7= Sunday).

boolean

Indicates if the whole day is considered as open (True) or closed (False).

string

When day is open, indicates the start of the opening window from 00:00 to 23:59.

string

When day is open, indicates the stop of the opening window from 00:01 to 24:00.

boolean

If set to true, then a second time window can be added, false by default.

string

Optional, When day is open and extended, indicates the start of the second opening window from 00:00 to 23:59.

string

Optional, When day is open and extended, indicates the stop of the second opening window from 00:00 to 23:59.

integer
1 to 7

The day of the week (1=Monday ... 7= Sunday).

boolean

Indicates if the whole day is considered as open (True) or closed (False).

string

When day is open, indicates the start of the opening window from 00:00 to 23:59.

string

When day is open, indicates the stop of the opening window from 00:01 to 24:00.

boolean

If set to true, then a second time window can be added, false by default.

string

Optional, When day is open and extended, indicates the start of the second opening window from 00:00 to 23:59.

string

Optional, When day is open and extended, indicates the stop of the second opening window from 00:00 to 23:59.

integer
1 to 7

The day of the week (1=Monday ... 7= Sunday).

boolean

Indicates if the whole day is considered as open (True) or closed (False).

string

When day is open, indicates the start of the opening window from 00:00 to 23:59.

string

When day is open, indicates the stop of the opening window from 00:01 to 24:00.

boolean

If set to true, then a second time window can be added, false by default.

string

Optional, When day is open and extended, indicates the start of the second opening window from 00:00 to 23:59.

string

Optional, When day is open and extended, indicates the stop of the second opening window from 00:00 to 23:59.

integer
1 to 7

The day of the week (1=Monday ... 7= Sunday).

boolean

Indicates if the whole day is considered as open (True) or closed (False).

string

When day is open, indicates the start of the opening window from 00:00 to 23:59.

string

When day is open, indicates the stop of the opening window from 00:01 to 24:00.

boolean

If set to true, then a second time window can be added, false by default.

string

Optional, When day is open and extended, indicates the start of the second opening window from 00:00 to 23:59.

string

Optional, When day is open and extended, indicates the stop of the second opening window from 00:00 to 23:59.

integer
1 to 7

The day of the week (1=Monday ... 7= Sunday).

boolean

Indicates if the whole day is considered as open (True) or closed (False).

string

When day is open, indicates the start of the opening window from 00:00 to 23:59.

string

When day is open, indicates the stop of the opening window from 00:01 to 24:00.

boolean

If set to true, then a second time window can be added, false by default.

string

Optional, When day is open and extended, indicates the start of the second opening window from 00:00 to 23:59.

string

Optional, When day is open and extended, indicates the stop of the second opening window from 00:00 to 23:59.

integer
1 to 7

The day of the week (1=Monday ... 7= Sunday).

boolean

Indicates if the whole day is considered as open (True) or closed (False).

string

When day is open, indicates the start of the opening window from 00:00 to 23:59.

string

When day is open, indicates the stop of the opening window from 00:01 to 24:00.

boolean

If set to true, then a second time window can be added, false by default.

string

Optional, When day is open and extended, indicates the start of the second opening window from 00:00 to 23:59.

string

Optional, When day is open and extended, indicates the stop of the second opening window from 00:00 to 23:59.

integer
1 to 7

The day of the week (1=Monday ... 7= Sunday).

boolean

Indicates if the whole day is considered as open (True) or closed (False).

string

When day is open, indicates the start of the opening window from 00:00 to 23:59.

string

When day is open, indicates the stop of the opening window from 00:01 to 24:00.

boolean

If set to true, then a second time window can be added, false by default.

string

Optional, When day is open and extended, indicates the start of the second opening window from 00:00 to 23:59.

string

Optional, When day is open and extended, indicates the stop of the second opening window from 00:00 to 23:59.

exclusions
array of dates

A list of days when the calendar is marked as closed, date set at midnight in epoch.

exclusions
Headers
string
Defaults to 2023-03-25

The version of API, by default use the last version.

Responses

Updated 8 months ago

Language
Credentials
OAuth2
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 8 months ago