Create a Calendar

post

https://api.naxai.com/calendars

Create a new calendar.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

name

string

required

^[0-9a-zA-Z-_ ]{3,30}$

The name of the calendar.

timezone

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*

day

integer

1 to 7

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

open

boolean

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

start

string

^([0-1]?[0-9]|2[0-3]):[0-5][0-9]$

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

stop

string

^([01]?\d|2[0-3]|24(?=:00?$)):([0-5]\d)$

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

extended

boolean

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

extensionStart

string

^([01]?\d|2[0-3]|24(?=:00?$)):([0-5]\d)$

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

extensionStop

string

^([01]?\d|2[0-3]|24(?=:00?$)):([0-5]\d)$

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

day

integer

1 to 7

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

open

boolean

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

start

string

^([0-1]?[0-9]|2[0-3]):[0-5][0-9]$

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

stop

string

^([01]?\d|2[0-3]|24(?=:00?$)):([0-5]\d)$

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

extended

boolean

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

extensionStart

string

^([01]?\d|2[0-3]|24(?=:00?$)):([0-5]\d)$

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

extensionStop

string

^([01]?\d|2[0-3]|24(?=:00?$)):([0-5]\d)$

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

day

integer

1 to 7

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

open

boolean

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

start

string

^([0-1]?[0-9]|2[0-3]):[0-5][0-9]$

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

stop

string

^([01]?\d|2[0-3]|24(?=:00?$)):([0-5]\d)$

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

extended

boolean

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

extensionStart

string

^([01]?\d|2[0-3]|24(?=:00?$)):([0-5]\d)$

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

extensionStop

string

^([01]?\d|2[0-3]|24(?=:00?$)):([0-5]\d)$

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

day

integer

1 to 7

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

open

boolean

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

start

string

^([0-1]?[0-9]|2[0-3]):[0-5][0-9]$

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

stop

string

^([01]?\d|2[0-3]|24(?=:00?$)):([0-5]\d)$

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

extended

boolean

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

extensionStart

string

^([01]?\d|2[0-3]|24(?=:00?$)):([0-5]\d)$

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

extensionStop

string

^([01]?\d|2[0-3]|24(?=:00?$)):([0-5]\d)$

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

day

integer

1 to 7

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

open

boolean

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

start

string

^([0-1]?[0-9]|2[0-3]):[0-5][0-9]$

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

stop

string

^([01]?\d|2[0-3]|24(?=:00?$)):([0-5]\d)$

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

extended

boolean

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

extensionStart

string

^([01]?\d|2[0-3]|24(?=:00?$)):([0-5]\d)$

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

extensionStop

string

^([01]?\d|2[0-3]|24(?=:00?$)):([0-5]\d)$

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

day

integer

1 to 7

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

open

boolean

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

start

string

^([0-1]?[0-9]|2[0-3]):[0-5][0-9]$

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

stop

string

^([01]?\d|2[0-3]|24(?=:00?$)):([0-5]\d)$

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

extended

boolean

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

extensionStart

string

^([01]?\d|2[0-3]|24(?=:00?$)):([0-5]\d)$

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

extensionStop

string

^([01]?\d|2[0-3]|24(?=:00?$)):([0-5]\d)$

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

day

integer

1 to 7

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

open

boolean

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

start

string

^([0-1]?[0-9]|2[0-3]):[0-5][0-9]$

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

stop

string

^([01]?\d|2[0-3]|24(?=:00?$)):([0-5]\d)$

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

extended

boolean

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

extensionStart

string

^([01]?\d|2[0-3]|24(?=:00?$)):([0-5]\d)$

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

extensionStop

string

^([01]?\d|2[0-3]|24(?=:00?$)):([0-5]\d)$

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

201A successful request returning the calendar created.

401Unauthorized request. Make sure that you provided the right credentials.

422The calendar has one or more validation errors.