Create domain time frame - NetSapiens API v2

Creates a time frame owned by the domain, shared by every user in it, of the type timeframe-type names. Answer rules use it by timeframe-name.

Requires Site Manager, Office Manager, Reseller, or Super User. A Basic User can read shared time frames but gets 403 on a write.

The write is published over the service bus (SBUS) and applied a moment later, so the call answers 202 by default. Send synchronous=yes to wait up to 10 seconds and get 200 with the time frame instead. The time frame ID is generated from the name and owner, so you do not send one; it is timeframe-id in the response.

Always. Matches at every moment and has no entries. The call waits about 2 seconds and always answers 200 with the time frame.

Days of week. One weekly schedule in timeframe-days-of-week-array, with up to 2 periods per day as hhmm times. The array is required and holds at most 1 entry. timeframe-recurrence-type is weekly, or custom with the custom interval fields.

Specific dates. Date ranges in timeframe-specific-dates-array, each with begin and end dates as YYYYMMDD and times as hhmm. With more than 1 range, all must share one recurrence type, annual-month-day or doesNotRecur.

Holiday. Holidays in timeframe-holiday-array, copied from GET /holidays/{country}/{year} or GET /holidays/{country}/{region}/{year}. Every holiday needs timeframe-holiday-begin-date and a timeframe-recurrence-type, never or yearlyOnHoliday, and all must share it. A holiday may appear once. A holiday whose date has already passed answers 422 and nothing is created.

Custom. Any mix of the three arrays, without the single-entry and shared-recurrence rules.

Every entry is checked before anything is published, so a 400 or 422 creates nothing. A name the owner already uses returns 400, and a user that does not exist returns 400 with Invalid user/domain. Add entries later with POST on the time frame, and change or convert it with PUT.

Bearer Token

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Responses

🟢200OK

application/json

The new time frame: with synchronous=yes once it is applied, and always for an always time frame.

Bodyapplication/json

🟠400Bad Request

🟠401Authentication Required

🟠404Record not found

🟢202Accepted

🟠422Unprocessable Content

🔴500Internal Server Error

🟠403Forbidden

curl --location 'https://awqacore01.crexendocloud.com/ns-api/v2/domains/example.com/timeframes' \ --header 'Authorization: Bearer <token>' \ --header 'Content-Type: application/json' \ --data '{ "timeframe-name": "Always On", "timeframe-type": "always" }'

{ "timeframe-id": "971f359bf4c55e87deaedae4bb5b1aa4", "timeframe-name": "Always On", "user": "*", "domain": "example.com", "timeframe-type": "always", "timeframe-end-date": null }