Create Custom Timeframe

When creating a Custom timeframe it is not necessary to supply a timeframe-id for the timeframe or for the entries within that timeframe. These timeframe-ids will be generated automatically.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required
length ≤ 64
^[A-Za-z0-9._-]*|~|\*+
Defaults to ~

This is the main organization name. This is used to link resource to its group/tenant/organization/enterprise. Then using in path for GET you can set to "~" to use the domain name linked to your token/key instead of the domain name itself when reading for your own domain.

string
required
length between 0 and 16
Defaults to ~

This is the main user extension for the user account. ~ can be used to mean "my account" which will extract the user from the token/key used for authentication.

Body Params
string
enum
required
Defaults to no

When synchronous is requested with "yes" the response will be a 200 on success and will contain a valid JSON representiation of the new resource. If no or left off request a 202 "Accepted" will be given in a success case and this can be considered a success. Synchronous responses will be a little slower as the API will process the geo replication request and wait till the local copy has been written and can be read back berfore sending a response.

Allowed:
string
string

days-of-week: Days of Week
specific-dates: Specific Dates
holiday: Holidays
custom: Custom
always: Always

timeframe-specific-dates-array
array of objects
timeframe-specific-dates-array
timeframe-holiday-array
array of objects
timeframe-holiday-array
timeframe-days-of-week-array
array of objects
timeframe-days-of-week-array
Response

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