Numbers and call routing

Schedules (time frames)

Time frames are the schedules answer rules and auto attendants use: business hours, holidays, one-off closures. They can be shared across the account or belong to one user.

In the Key Admin this is the Schedules (time frames) switch. Read lets a key call the GET endpoints below. Write lets it call the ones that change data.

Count schedules

GET/domains/~/schedule/count

Returns how many schedule there are on the account, as {"total": n}.

Read Key Admin switch: Schedules (time frames), Read. Read only keys also work.

Example request

curl -X GET "https://api.noodlevoice.com/ns-api/v2/domains/~/schedule/count" \
  -H "Authorization: Bearer $NOODLEVOICE_KEY"

const res = await fetch("https://api.noodlevoice.com/ns-api/v2/domains/~/schedule/count", {
  method: "GET",
  headers: {
    Authorization: "Bearer " + process.env.NOODLEVOICE_KEY,
  },
});
const data = await res.json();

import os, requests

r = requests.get(
    "https://api.noodlevoice.com/ns-api/v2/domains/~/schedule/count",
    headers={"Authorization": "Bearer " + os.environ["NOODLEVOICE_KEY"]},
)
print(r.status_code, r.json())

Response 200

{
  "total": 1
}

Response fields (1)

Field	Type	Notes
`total`	integer	How many items matched.

Other responses: 400, 401, 403, 404. See errors.

Check a schedule exists

GET/domains/~/schedule/{schedule_name}/count

Returns a total of 1 when the named schedule exists.

Read Key Admin switch: Schedules (time frames), Read. Read only keys also work.

Parameters

Name	In	Type	Notes
`schedule_name` required	path	string	The schedule name.

Example request

curl -X GET "https://api.noodlevoice.com/ns-api/v2/domains/~/schedule/Business%20Hours/count" \
  -H "Authorization: Bearer $NOODLEVOICE_KEY"

const res = await fetch("https://api.noodlevoice.com/ns-api/v2/domains/~/schedule/Business%20Hours/count", {
  method: "GET",
  headers: {
    Authorization: "Bearer " + process.env.NOODLEVOICE_KEY,
  },
});
const data = await res.json();

import os, requests

r = requests.get(
    "https://api.noodlevoice.com/ns-api/v2/domains/~/schedule/Business%20Hours/count",
    headers={"Authorization": "Bearer " + os.environ["NOODLEVOICE_KEY"]},
)
print(r.status_code, r.json())

Response 200

{
  "total": 1
}

Response fields (1)

Field	Type	Notes
`total`	integer	How many items matched.

Other responses: 400, 401, 403, 404. See errors.

List time frames

GET/domains/~/timeframes

Returns the time frames on the account.

Read Key Admin switch: Schedules (time frames), Read. Read only keys also work.

Example request

curl -X GET "https://api.noodlevoice.com/ns-api/v2/domains/~/timeframes" \
  -H "Authorization: Bearer $NOODLEVOICE_KEY"

const res = await fetch("https://api.noodlevoice.com/ns-api/v2/domains/~/timeframes", {
  method: "GET",
  headers: {
    Authorization: "Bearer " + process.env.NOODLEVOICE_KEY,
  },
});
const data = await res.json();

import os, requests

r = requests.get(
    "https://api.noodlevoice.com/ns-api/v2/domains/~/timeframes",
    headers={"Authorization": "Bearer " + os.environ["NOODLEVOICE_KEY"]},
)
print(r.status_code, r.json())

Response 200

[
  {
    "timeframe-id": "string",
    "timeframe-name": "Front Desk",
    "user": "1001",
    "domain": "string",
    "timeframe-type": "string",
    "timeframe-specific-dates-array": [
      {}
    ],
    "timeframe-holiday-array": [
      {}
    ],
    "timeframe-days-of-week-array": [
      {}
    ]
  }
]

Response fields (96)

Field	Type	Notes
`timeframe-id`	string	The time frame's ID.
`timeframe-name`	string	Name of the time frame.
`user`	string	The user ID (extension).
`domain`	string	The account the item belongs to.
`timeframe-type`	string	What kind of time frame it is.
`timeframe-specific-dates-array`	array of object
`timeframe-specific-dates-array[].timeframe-id`	string	The time frame's ID.
`timeframe-specific-dates-array[].timeframe-parent-id`	string	ID of the timeframe parent.
`timeframe-specific-dates-array[].ordinal-order`	number
`timeframe-specific-dates-array[].timeframe-specific-dates-begin-date`	string	Timeframe specific dates begin (date).
`timeframe-specific-dates-array[].timeframe-specific-dates-begin-time`	string
`timeframe-specific-dates-array[].timeframe-specific-dates-end-date`	string	Timeframe specific dates end (date).
`timeframe-specific-dates-array[].timeframe-specific-dates-end-time`	string
`timeframe-specific-dates-array[].timeframe-recurrence-type`	string
`timeframe-specific-dates-array[].timeframe-recurrence-custom-interval`	string
`timeframe-specific-dates-array[].timeframe-recurrence-custom-interval-count`	string	Number of timeframe recurrence custom interval.
`timeframe-specific-dates-array[].timeframe-recurrence-custom-interval-option`	string
`timeframe-specific-dates-array[].timeframe-recurrence-end-option`	string
`timeframe-specific-dates-array[].timeframe-recurrence-end-date`	string	Timeframe recurrence end (date).
`timeframe-specific-dates-array[].timeframe-expiry-datetime`	string	Timeframe expiry (date and time).
`timeframe-specific-dates-array[].domain`	string	The account the item belongs to.
`timeframe-specific-dates-array[].timeframe-recurrence-rrule`	string
`timeframe-specific-dates-array[].timeframe-next-observance-datetime`	array of number	Timeframe next observance (date and time).
`timeframe-specific-dates-array[].timeframe-is-v1`	boolean
`timeframe-holiday-array`	array of object
`timeframe-holiday-array[].timeframe-id`	string	The time frame's ID.
`timeframe-holiday-array[].timeframe-parent-id`	string	ID of the timeframe parent.
`timeframe-holiday-array[].ordinal-order`	number
`timeframe-holiday-array[].timeframe-holiday-uuid`	string
`timeframe-holiday-array[].timeframe-holiday-name`	string	Name of the timeframe holiday.
`timeframe-holiday-array[].timeframe-holiday-begin-date`	string	Timeframe holiday begin (date).
`timeframe-holiday-array[].country-abbreviation`	string
`timeframe-holiday-array[].state-province-abbreviation`	string
`timeframe-holiday-array[].holiday-api-location-hint`	string
`timeframe-holiday-array[].timeframe-holiday-begin-time-1`	string
`timeframe-holiday-array[].timeframe-holiday-end-time-1`	string
`timeframe-holiday-array[].timeframe-holiday-begin-time-2`	string
`timeframe-holiday-array[].timeframe-holiday-end-time-2`	string
`timeframe-holiday-array[].timeframe-weekly-monday-observance-option`	string
`timeframe-holiday-array[].timeframe-weekly-tuesday-observance-option`	string
`timeframe-holiday-array[].timeframe-weekly-wednesday-observance-option`	string
`timeframe-holiday-array[].timeframe-weekly-thursday-observance-option`	string
`timeframe-holiday-array[].timeframe-weekly-friday-observance-option`	string
`timeframe-holiday-array[].timeframe-weekly-saturday-observance-option`	string
`timeframe-holiday-array[].timeframe-weekly-sunday-observance-option`	string
`timeframe-holiday-array[].timeframe-workweek-list`	string
`timeframe-holiday-array[].timeframe-recurrence-type`	string
`timeframe-holiday-array[].timeframe-recurrence-end-option`	string
`timeframe-holiday-array[].timeframe-recurrence-end-date`	string	Timeframe recurrence end (date).
`timeframe-holiday-array[].timeframe-expiry-datetime`	string	Timeframe expiry (date and time).
`timeframe-holiday-array[].domain`	string	The account the item belongs to.
`timeframe-holiday-array[].timeframe-next-observance-datetime`	array of number	Timeframe next observance (date and time).
`timeframe-days-of-week-array`	array of object
`timeframe-days-of-week-array[].timeframe-id`	string	The time frame's ID.
`timeframe-days-of-week-array[].timeframe-parent-id`	string	ID of the timeframe parent.
`timeframe-days-of-week-array[].ordinal-order`	number
`timeframe-days-of-week-array[].timeframe-weekly-sunday-begin-time-1`	string
`timeframe-days-of-week-array[].timeframe-weekly-sunday-end-time-1`	string
`timeframe-days-of-week-array[].timeframe-weekly-sunday-begin-time-2`	string
`timeframe-days-of-week-array[].timeframe-weekly-sunday-end-time-2`	string
`timeframe-days-of-week-array[].timeframe-weekly-monday-begin-time-1`	string
`timeframe-days-of-week-array[].timeframe-weekly-monday-end-time-1`	string
`timeframe-days-of-week-array[].timeframe-weekly-monday-begin-time-2`	string
`timeframe-days-of-week-array[].timeframe-weekly-monday-end-time-2`	string
`timeframe-days-of-week-array[].timeframe-weekly-tuesday-begin-time-1`	string
`timeframe-days-of-week-array[].timeframe-weekly-tuesday-end-time-1`	string
`timeframe-days-of-week-array[].timeframe-weekly-tuesday-begin-time-2`	string
`timeframe-days-of-week-array[].timeframe-weekly-tuesday-end-time-2`	string
`timeframe-days-of-week-array[].timeframe-weekly-wednesday-begin-time-1`	string
`timeframe-days-of-week-array[].timeframe-weekly-wednesday-end-time-1`	string
`timeframe-days-of-week-array[].timeframe-weekly-wednesday-begin-time-2`	string
`timeframe-days-of-week-array[].timeframe-weekly-wednesday-end-time-2`	string
`timeframe-days-of-week-array[].timeframe-weekly-thursday-begin-time-1`	string
`timeframe-days-of-week-array[].timeframe-weekly-thursday-end-time-1`	string
`timeframe-days-of-week-array[].timeframe-weekly-thursday-begin-time-2`	string
`timeframe-days-of-week-array[].timeframe-weekly-thursday-end-time-2`	string
`timeframe-days-of-week-array[].timeframe-weekly-friday-begin-time-1`	string
`timeframe-days-of-week-array[].timeframe-weekly-friday-end-time-1`	string
`timeframe-days-of-week-array[].timeframe-weekly-friday-begin-time-2`	string
`timeframe-days-of-week-array[].timeframe-weekly-friday-end-time-2`	string
`timeframe-days-of-week-array[].timeframe-weekly-saturday-begin-time-1`	string
`timeframe-days-of-week-array[].timeframe-weekly-saturday-end-time-1`	string
`timeframe-days-of-week-array[].timeframe-weekly-saturday-begin-time-2`	string
`timeframe-days-of-week-array[].timeframe-weekly-saturday-end-time-2`	string
`timeframe-days-of-week-array[].timeframe-recurrence-type`	string
`timeframe-days-of-week-array[].timeframe-recurrence-begin-date`	string	Timeframe recurrence begin (date).
`timeframe-days-of-week-array[].timeframe-recurrence-custom-interval`	string
`timeframe-days-of-week-array[].timeframe-recurrence-custom-interval-count`	string	Number of timeframe recurrence custom interval.
`timeframe-days-of-week-array[].timeframe-recurrence-custom-interval-option`	string
`timeframe-days-of-week-array[].timeframe-recurrence-end-option`	string
`timeframe-days-of-week-array[].timeframe-recurrence-end-date`	string	Timeframe recurrence end (date).
`timeframe-days-of-week-array[].timeframe-expiry-datetime`	string	Timeframe expiry (date and time).
`timeframe-days-of-week-array[].domain`	string	The account the item belongs to.
`timeframe-days-of-week-array[].timeframe-next-observance-datetime`	array of number	Timeframe next observance (date and time).
`timeframe-days-of-week-array[].timeframe-recurrence-rrule`	string
`timeframe-days-of-week-array[].timeframe-is-v1`	boolean

Get a time frame

GET/domains/~/timeframes/{id}

Returns one time frame by its ID.

Read Key Admin switch: Schedules (time frames), Read. Read only keys also work.

Parameters

Name	In	Type	Notes
`id` required	path	string	The ID of the item, as returned when you list or create it.

Example request

curl -X GET "https://api.noodlevoice.com/ns-api/v2/domains/~/timeframes/{id}" \
  -H "Authorization: Bearer $NOODLEVOICE_KEY"

const res = await fetch("https://api.noodlevoice.com/ns-api/v2/domains/~/timeframes/{id}", {
  method: "GET",
  headers: {
    Authorization: "Bearer " + process.env.NOODLEVOICE_KEY,
  },
});
const data = await res.json();

import os, requests

r = requests.get(
    "https://api.noodlevoice.com/ns-api/v2/domains/~/timeframes/{id}",
    headers={"Authorization": "Bearer " + os.environ["NOODLEVOICE_KEY"]},
)
print(r.status_code, r.json())

Response 200

Returns a status code with a short JSON message.

Create a specific dates time frame

POST/domains/~/timeframes

Adds a shared time frame made of date and time ranges, such as a one-off closure.

Write Key Admin switch: Schedules (time frames), Write.

Request body application/json

Field	Type	Notes
`synchronous` required	string	Set to `yes` to wait until the change is finished before the response comes back. One of: `yes`, `no` Default `no`
`timeframe-name`	string	Name of the time frame.
`timeframe-type`	string	What kind of time frame it is.
`timeframe-specific-dates-array`	array of object
`timeframe-specific-dates-array[].timeframe-id`	string	The time frame's ID.
`timeframe-specific-dates-array[].timeframe-parent-id`	string	ID of the timeframe parent.
`timeframe-specific-dates-array[].ordinal-order`	number
`timeframe-specific-dates-array[].timeframe-specific-dates-begin-date` required	string	Timeframe specific dates begin (date).
`timeframe-specific-dates-array[].timeframe-specific-dates-begin-time` required	string
`timeframe-specific-dates-array[].timeframe-specific-dates-end-date` required	string	Timeframe specific dates end (date).
`timeframe-specific-dates-array[].timeframe-specific-dates-end-time` required	string
`timeframe-specific-dates-array[].timeframe-recurrence-type` required	string
`timeframe-specific-dates-array[].timeframe-recurrence-custom-interval` required	string
`timeframe-specific-dates-array[].timeframe-recurrence-custom-interval-count` required	string	Number of timeframe recurrence custom interval.
`timeframe-specific-dates-array[].timeframe-recurrence-custom-interval-option` required	string
`timeframe-specific-dates-array[].timeframe-recurrence-end-option` required	string
`timeframe-specific-dates-array[].timeframe-recurrence-end-date` required	string	Timeframe recurrence end (date).
`timeframe-specific-dates-array[].timeframe-expiry-datetime`	string	Timeframe expiry (date and time).
`timeframe-specific-dates-array[].domain`	string	The account the item belongs to.
`timeframe-specific-dates-array[].timeframe-recurrence-rrule`	string
`timeframe-specific-dates-array[].timeframe-next-observance-datetime`	array of number	Timeframe next observance (date and time).
`timeframe-specific-dates-array[].timeframe-is-v1`	boolean

Example request

curl -X POST "https://api.noodlevoice.com/ns-api/v2/domains/~/timeframes" \
  -H "Authorization: Bearer $NOODLEVOICE_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "synchronous": "yes"
  }'

const res = await fetch("https://api.noodlevoice.com/ns-api/v2/domains/~/timeframes", {
  method: "POST",
  headers: {
    Authorization: "Bearer " + process.env.NOODLEVOICE_KEY,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "synchronous": "yes"
  }),
});
const data = await res.json();

import os, requests

r = requests.post(
    "https://api.noodlevoice.com/ns-api/v2/domains/~/timeframes",
    headers={"Authorization": "Bearer " + os.environ["NOODLEVOICE_KEY"]},
    json={
        "synchronous": "yes"
    },
)
print(r.status_code, r.json())

Response 200

{
  "timeframe-name": "Front Desk",
  "timeframe-type": "string",
  "timeframe-specific-dates-array": [
    {}
  ],
  "timeframe-days-of-week-array": [
    {}
  ]
}

Response fields (65)

Field	Type	Notes
`timeframe-name`	string	Name of the time frame.
`timeframe-type`	string	What kind of time frame it is.
`timeframe-specific-dates-array`	array of object
`timeframe-specific-dates-array[].timeframe-id`	string	The time frame's ID.
`timeframe-specific-dates-array[].timeframe-parent-id`	string	ID of the timeframe parent.
`timeframe-specific-dates-array[].ordinal-order`	number
`timeframe-specific-dates-array[].timeframe-specific-dates-begin-date`	string	Timeframe specific dates begin (date).
`timeframe-specific-dates-array[].timeframe-specific-dates-begin-time`	string
`timeframe-specific-dates-array[].timeframe-specific-dates-end-date`	string	Timeframe specific dates end (date).
`timeframe-specific-dates-array[].timeframe-specific-dates-end-time`	string
`timeframe-specific-dates-array[].timeframe-recurrence-type`	string
`timeframe-specific-dates-array[].timeframe-recurrence-custom-interval`	string
`timeframe-specific-dates-array[].timeframe-recurrence-custom-interval-count`	string	Number of timeframe recurrence custom interval.
`timeframe-specific-dates-array[].timeframe-recurrence-custom-interval-option`	string
`timeframe-specific-dates-array[].timeframe-recurrence-end-option`	string
`timeframe-specific-dates-array[].timeframe-recurrence-end-date`	string	Timeframe recurrence end (date).
`timeframe-specific-dates-array[].timeframe-expiry-datetime`	string	Timeframe expiry (date and time).
`timeframe-specific-dates-array[].domain`	string	The account the item belongs to.
`timeframe-specific-dates-array[].timeframe-recurrence-rrule`	string
`timeframe-specific-dates-array[].timeframe-next-observance-datetime`	array of number	Timeframe next observance (date and time).
`timeframe-specific-dates-array[].timeframe-is-v1`	boolean
`timeframe-days-of-week-array`	array of object
`timeframe-days-of-week-array[].timeframe-id`	string	The time frame's ID.
`timeframe-days-of-week-array[].timeframe-parent-id`	string	ID of the timeframe parent.
`timeframe-days-of-week-array[].ordinal-order`	number
`timeframe-days-of-week-array[].timeframe-weekly-sunday-begin-time-1`	string
`timeframe-days-of-week-array[].timeframe-weekly-sunday-end-time-1`	string
`timeframe-days-of-week-array[].timeframe-weekly-sunday-begin-time-2`	string
`timeframe-days-of-week-array[].timeframe-weekly-sunday-end-time-2`	string
`timeframe-days-of-week-array[].timeframe-weekly-monday-begin-time-1`	string
`timeframe-days-of-week-array[].timeframe-weekly-monday-end-time-1`	string
`timeframe-days-of-week-array[].timeframe-weekly-monday-begin-time-2`	string
`timeframe-days-of-week-array[].timeframe-weekly-monday-end-time-2`	string
`timeframe-days-of-week-array[].timeframe-weekly-tuesday-begin-time-1`	string
`timeframe-days-of-week-array[].timeframe-weekly-tuesday-end-time-1`	string
`timeframe-days-of-week-array[].timeframe-weekly-tuesday-begin-time-2`	string
`timeframe-days-of-week-array[].timeframe-weekly-tuesday-end-time-2`	string
`timeframe-days-of-week-array[].timeframe-weekly-wednesday-begin-time-1`	string
`timeframe-days-of-week-array[].timeframe-weekly-wednesday-end-time-1`	string
`timeframe-days-of-week-array[].timeframe-weekly-wednesday-begin-time-2`	string
`timeframe-days-of-week-array[].timeframe-weekly-wednesday-end-time-2`	string
`timeframe-days-of-week-array[].timeframe-weekly-thursday-begin-time-1`	string
`timeframe-days-of-week-array[].timeframe-weekly-thursday-end-time-1`	string
`timeframe-days-of-week-array[].timeframe-weekly-thursday-begin-time-2`	string
`timeframe-days-of-week-array[].timeframe-weekly-thursday-end-time-2`	string
`timeframe-days-of-week-array[].timeframe-weekly-friday-begin-time-1`	string
`timeframe-days-of-week-array[].timeframe-weekly-friday-end-time-1`	string
`timeframe-days-of-week-array[].timeframe-weekly-friday-begin-time-2`	string
`timeframe-days-of-week-array[].timeframe-weekly-friday-end-time-2`	string
`timeframe-days-of-week-array[].timeframe-weekly-saturday-begin-time-1`	string
`timeframe-days-of-week-array[].timeframe-weekly-saturday-end-time-1`	string
`timeframe-days-of-week-array[].timeframe-weekly-saturday-begin-time-2`	string
`timeframe-days-of-week-array[].timeframe-weekly-saturday-end-time-2`	string
`timeframe-days-of-week-array[].timeframe-recurrence-type`	string
`timeframe-days-of-week-array[].timeframe-recurrence-begin-date`	string	Timeframe recurrence begin (date).
`timeframe-days-of-week-array[].timeframe-recurrence-custom-interval`	string
`timeframe-days-of-week-array[].timeframe-recurrence-custom-interval-count`	string	Number of timeframe recurrence custom interval.
`timeframe-days-of-week-array[].timeframe-recurrence-custom-interval-option`	string
`timeframe-days-of-week-array[].timeframe-recurrence-end-option`	string
`timeframe-days-of-week-array[].timeframe-recurrence-end-date`	string	Timeframe recurrence end (date).
`timeframe-days-of-week-array[].timeframe-expiry-datetime`	string	Timeframe expiry (date and time).
`timeframe-days-of-week-array[].domain`	string	The account the item belongs to.
`timeframe-days-of-week-array[].timeframe-next-observance-datetime`	array of number	Timeframe next observance (date and time).
`timeframe-days-of-week-array[].timeframe-recurrence-rrule`	string
`timeframe-days-of-week-array[].timeframe-is-v1`	boolean

Create a days of week time frame

POST/domains/~/timeframes

Adds a shared time frame for weekly hours, such as Monday to Friday 9 to 5.

Write Key Admin switch: Schedules (time frames), Write.

Request body application/json

Field	Type	Notes
`synchronous` required	string	Set to `yes` to wait until the change is finished before the response comes back. One of: `yes`, `no` Default `no`
`timeframe-name`	string	Name of the time frame.
`timeframe-type`	string	What kind of time frame it is.
`timeframe-days-of-week-array`	array of object
`timeframe-days-of-week-array[].timeframe-id`	string	The time frame's ID.
`timeframe-days-of-week-array[].timeframe-parent-id`	string	ID of the timeframe parent.
`timeframe-days-of-week-array[].ordinal-order`	number
`timeframe-days-of-week-array[].timeframe-weekly-sunday-begin-time-1`	string
`timeframe-days-of-week-array[].timeframe-weekly-sunday-end-time-1`	string
`timeframe-days-of-week-array[].timeframe-weekly-sunday-begin-time-2`	string
`timeframe-days-of-week-array[].timeframe-weekly-sunday-end-time-2`	string
`timeframe-days-of-week-array[].timeframe-weekly-monday-begin-time-1`	string
`timeframe-days-of-week-array[].timeframe-weekly-monday-end-time-1`	string
`timeframe-days-of-week-array[].timeframe-weekly-monday-begin-time-2`	string
`timeframe-days-of-week-array[].timeframe-weekly-monday-end-time-2`	string
`timeframe-days-of-week-array[].timeframe-weekly-tuesday-begin-time-1`	string
`timeframe-days-of-week-array[].timeframe-weekly-tuesday-end-time-1`	string
`timeframe-days-of-week-array[].timeframe-weekly-tuesday-begin-time-2`	string
`timeframe-days-of-week-array[].timeframe-weekly-tuesday-end-time-2`	string
`timeframe-days-of-week-array[].timeframe-weekly-wednesday-begin-time-1`	string
`timeframe-days-of-week-array[].timeframe-weekly-wednesday-end-time-1`	string
`timeframe-days-of-week-array[].timeframe-weekly-wednesday-begin-time-2`	string
`timeframe-days-of-week-array[].timeframe-weekly-wednesday-end-time-2`	string
`timeframe-days-of-week-array[].timeframe-weekly-thursday-begin-time-1`	string
`timeframe-days-of-week-array[].timeframe-weekly-thursday-end-time-1`	string
`timeframe-days-of-week-array[].timeframe-weekly-thursday-begin-time-2`	string
`timeframe-days-of-week-array[].timeframe-weekly-thursday-end-time-2`	string
`timeframe-days-of-week-array[].timeframe-weekly-friday-begin-time-1`	string
`timeframe-days-of-week-array[].timeframe-weekly-friday-end-time-1`	string
`timeframe-days-of-week-array[].timeframe-weekly-friday-begin-time-2`	string
`timeframe-days-of-week-array[].timeframe-weekly-friday-end-time-2`	string
`timeframe-days-of-week-array[].timeframe-weekly-saturday-begin-time-1`	string
`timeframe-days-of-week-array[].timeframe-weekly-saturday-end-time-1`	string
`timeframe-days-of-week-array[].timeframe-weekly-saturday-begin-time-2`	string
`timeframe-days-of-week-array[].timeframe-weekly-saturday-end-time-2`	string
`timeframe-days-of-week-array[].timeframe-recurrence-type` required	string
`timeframe-days-of-week-array[].timeframe-recurrence-begin-date` required	string	Timeframe recurrence begin (date).
`timeframe-days-of-week-array[].timeframe-recurrence-custom-interval` required	string
`timeframe-days-of-week-array[].timeframe-recurrence-custom-interval-count` required	string	Number of timeframe recurrence custom interval.
`timeframe-days-of-week-array[].timeframe-recurrence-custom-interval-option` required	string
`timeframe-days-of-week-array[].timeframe-recurrence-end-option` required	string
`timeframe-days-of-week-array[].timeframe-recurrence-end-date` required	string	Timeframe recurrence end (date).
`timeframe-days-of-week-array[].timeframe-expiry-datetime`	string	Timeframe expiry (date and time).
`timeframe-days-of-week-array[].domain`	string	The account the item belongs to.
`timeframe-days-of-week-array[].timeframe-next-observance-datetime`	array of number	Timeframe next observance (date and time).
`timeframe-days-of-week-array[].timeframe-recurrence-rrule`	string
`timeframe-days-of-week-array[].timeframe-is-v1`	boolean

Example request

curl -X POST "https://api.noodlevoice.com/ns-api/v2/domains/~/timeframes" \
  -H "Authorization: Bearer $NOODLEVOICE_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "synchronous": "yes"
  }'

const res = await fetch("https://api.noodlevoice.com/ns-api/v2/domains/~/timeframes", {
  method: "POST",
  headers: {
    Authorization: "Bearer " + process.env.NOODLEVOICE_KEY,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "synchronous": "yes"
  }),
});
const data = await res.json();

import os, requests

r = requests.post(
    "https://api.noodlevoice.com/ns-api/v2/domains/~/timeframes",
    headers={"Authorization": "Bearer " + os.environ["NOODLEVOICE_KEY"]},
    json={
        "synchronous": "yes"
    },
)
print(r.status_code, r.json())

Response 200

{
  "timeframe-id": "string",
  "timeframe-name": "Front Desk",
  "user": "1001",
  "domain": "string",
  "timeframe-type": "string",
  "timeframe-specific-dates-array": [
    {}
  ],
  "timeframe-holiday-array": [
    {}
  ],
  "timeframe-days-of-week-array": [
    {}
  ]
}

Response fields (96)

Field	Type	Notes
`timeframe-id`	string	The time frame's ID.
`timeframe-name`	string	Name of the time frame.
`user`	string	The user ID (extension).
`domain`	string	The account the item belongs to.
`timeframe-type`	string	What kind of time frame it is.
`timeframe-specific-dates-array`	array of object
`timeframe-specific-dates-array[].timeframe-id`	string	The time frame's ID.
`timeframe-specific-dates-array[].timeframe-parent-id`	string	ID of the timeframe parent.
`timeframe-specific-dates-array[].ordinal-order`	number
`timeframe-specific-dates-array[].timeframe-specific-dates-begin-date`	string	Timeframe specific dates begin (date).
`timeframe-specific-dates-array[].timeframe-specific-dates-begin-time`	string
`timeframe-specific-dates-array[].timeframe-specific-dates-end-date`	string	Timeframe specific dates end (date).
`timeframe-specific-dates-array[].timeframe-specific-dates-end-time`	string
`timeframe-specific-dates-array[].timeframe-recurrence-type`	string
`timeframe-specific-dates-array[].timeframe-recurrence-custom-interval`	string
`timeframe-specific-dates-array[].timeframe-recurrence-custom-interval-count`	string	Number of timeframe recurrence custom interval.
`timeframe-specific-dates-array[].timeframe-recurrence-custom-interval-option`	string
`timeframe-specific-dates-array[].timeframe-recurrence-end-option`	string
`timeframe-specific-dates-array[].timeframe-recurrence-end-date`	string	Timeframe recurrence end (date).
`timeframe-specific-dates-array[].timeframe-expiry-datetime`	string	Timeframe expiry (date and time).
`timeframe-specific-dates-array[].domain`	string	The account the item belongs to.
`timeframe-specific-dates-array[].timeframe-recurrence-rrule`	string
`timeframe-specific-dates-array[].timeframe-next-observance-datetime`	array of number	Timeframe next observance (date and time).
`timeframe-specific-dates-array[].timeframe-is-v1`	boolean
`timeframe-holiday-array`	array of object
`timeframe-holiday-array[].timeframe-id`	string	The time frame's ID.
`timeframe-holiday-array[].timeframe-parent-id`	string	ID of the timeframe parent.
`timeframe-holiday-array[].ordinal-order`	number
`timeframe-holiday-array[].timeframe-holiday-uuid`	string
`timeframe-holiday-array[].timeframe-holiday-name`	string	Name of the timeframe holiday.
`timeframe-holiday-array[].timeframe-holiday-begin-date`	string	Timeframe holiday begin (date).
`timeframe-holiday-array[].country-abbreviation`	string
`timeframe-holiday-array[].state-province-abbreviation`	string
`timeframe-holiday-array[].holiday-api-location-hint`	string
`timeframe-holiday-array[].timeframe-holiday-begin-time-1`	string
`timeframe-holiday-array[].timeframe-holiday-end-time-1`	string
`timeframe-holiday-array[].timeframe-holiday-begin-time-2`	string
`timeframe-holiday-array[].timeframe-holiday-end-time-2`	string
`timeframe-holiday-array[].timeframe-weekly-monday-observance-option`	string
`timeframe-holiday-array[].timeframe-weekly-tuesday-observance-option`	string
`timeframe-holiday-array[].timeframe-weekly-wednesday-observance-option`	string
`timeframe-holiday-array[].timeframe-weekly-thursday-observance-option`	string
`timeframe-holiday-array[].timeframe-weekly-friday-observance-option`	string
`timeframe-holiday-array[].timeframe-weekly-saturday-observance-option`	string
`timeframe-holiday-array[].timeframe-weekly-sunday-observance-option`	string
`timeframe-holiday-array[].timeframe-workweek-list`	string
`timeframe-holiday-array[].timeframe-recurrence-type`	string
`timeframe-holiday-array[].timeframe-recurrence-end-option`	string
`timeframe-holiday-array[].timeframe-recurrence-end-date`	string	Timeframe recurrence end (date).
`timeframe-holiday-array[].timeframe-expiry-datetime`	string	Timeframe expiry (date and time).
`timeframe-holiday-array[].domain`	string	The account the item belongs to.
`timeframe-holiday-array[].timeframe-next-observance-datetime`	array of number	Timeframe next observance (date and time).
`timeframe-days-of-week-array`	array of object
`timeframe-days-of-week-array[].timeframe-id`	string	The time frame's ID.
`timeframe-days-of-week-array[].timeframe-parent-id`	string	ID of the timeframe parent.
`timeframe-days-of-week-array[].ordinal-order`	number
`timeframe-days-of-week-array[].timeframe-weekly-sunday-begin-time-1`	string
`timeframe-days-of-week-array[].timeframe-weekly-sunday-end-time-1`	string
`timeframe-days-of-week-array[].timeframe-weekly-sunday-begin-time-2`	string
`timeframe-days-of-week-array[].timeframe-weekly-sunday-end-time-2`	string
`timeframe-days-of-week-array[].timeframe-weekly-monday-begin-time-1`	string
`timeframe-days-of-week-array[].timeframe-weekly-monday-end-time-1`	string
`timeframe-days-of-week-array[].timeframe-weekly-monday-begin-time-2`	string
`timeframe-days-of-week-array[].timeframe-weekly-monday-end-time-2`	string
`timeframe-days-of-week-array[].timeframe-weekly-tuesday-begin-time-1`	string
`timeframe-days-of-week-array[].timeframe-weekly-tuesday-end-time-1`	string
`timeframe-days-of-week-array[].timeframe-weekly-tuesday-begin-time-2`	string
`timeframe-days-of-week-array[].timeframe-weekly-tuesday-end-time-2`	string
`timeframe-days-of-week-array[].timeframe-weekly-wednesday-begin-time-1`	string
`timeframe-days-of-week-array[].timeframe-weekly-wednesday-end-time-1`	string
`timeframe-days-of-week-array[].timeframe-weekly-wednesday-begin-time-2`	string
`timeframe-days-of-week-array[].timeframe-weekly-wednesday-end-time-2`	string
`timeframe-days-of-week-array[].timeframe-weekly-thursday-begin-time-1`	string
`timeframe-days-of-week-array[].timeframe-weekly-thursday-end-time-1`	string
`timeframe-days-of-week-array[].timeframe-weekly-thursday-begin-time-2`	string
`timeframe-days-of-week-array[].timeframe-weekly-thursday-end-time-2`	string
`timeframe-days-of-week-array[].timeframe-weekly-friday-begin-time-1`	string
`timeframe-days-of-week-array[].timeframe-weekly-friday-end-time-1`	string
`timeframe-days-of-week-array[].timeframe-weekly-friday-begin-time-2`	string
`timeframe-days-of-week-array[].timeframe-weekly-friday-end-time-2`	string
`timeframe-days-of-week-array[].timeframe-weekly-saturday-begin-time-1`	string
`timeframe-days-of-week-array[].timeframe-weekly-saturday-end-time-1`	string
`timeframe-days-of-week-array[].timeframe-weekly-saturday-begin-time-2`	string
`timeframe-days-of-week-array[].timeframe-weekly-saturday-end-time-2`	string
`timeframe-days-of-week-array[].timeframe-recurrence-type`	string
`timeframe-days-of-week-array[].timeframe-recurrence-begin-date`	string	Timeframe recurrence begin (date).
`timeframe-days-of-week-array[].timeframe-recurrence-custom-interval`	string
`timeframe-days-of-week-array[].timeframe-recurrence-custom-interval-count`	string	Number of timeframe recurrence custom interval.
`timeframe-days-of-week-array[].timeframe-recurrence-custom-interval-option`	string
`timeframe-days-of-week-array[].timeframe-recurrence-end-option`	string
`timeframe-days-of-week-array[].timeframe-recurrence-end-date`	string	Timeframe recurrence end (date).
`timeframe-days-of-week-array[].timeframe-expiry-datetime`	string	Timeframe expiry (date and time).
`timeframe-days-of-week-array[].domain`	string	The account the item belongs to.
`timeframe-days-of-week-array[].timeframe-next-observance-datetime`	array of number	Timeframe next observance (date and time).
`timeframe-days-of-week-array[].timeframe-recurrence-rrule`	string
`timeframe-days-of-week-array[].timeframe-is-v1`	boolean

Create a holidays time frame

POST/domains/~/timeframes

Adds a shared time frame made of holidays.

Write Key Admin switch: Schedules (time frames), Write.

Request body application/json

Field	Type	Notes
`synchronous` required	string	Set to `yes` to wait until the change is finished before the response comes back. One of: `yes`, `no` Default `no`
`timeframe-name`	string	Name of the time frame.
`timeframe-type`	string	What kind of time frame it is.
`timeframe-holiday-array`	array of object
`timeframe-holiday-array[].timeframe-id`	string	The time frame's ID.
`timeframe-holiday-array[].timeframe-parent-id`	string	ID of the timeframe parent.
`timeframe-holiday-array[].ordinal-order`	number
`timeframe-holiday-array[].timeframe-holiday-uuid` required	string
`timeframe-holiday-array[].timeframe-holiday-name` required	string	Name of the timeframe holiday.
`timeframe-holiday-array[].timeframe-holiday-begin-date` required	string	Timeframe holiday begin (date).
`timeframe-holiday-array[].country-abbreviation` required	string
`timeframe-holiday-array[].state-province-abbreviation` required	string
`timeframe-holiday-array[].holiday-api-location-hint` required	string
`timeframe-holiday-array[].timeframe-holiday-begin-time-1` required	string
`timeframe-holiday-array[].timeframe-holiday-end-time-1` required	string
`timeframe-holiday-array[].timeframe-holiday-begin-time-2` required	string
`timeframe-holiday-array[].timeframe-holiday-end-time-2` required	string
`timeframe-holiday-array[].timeframe-weekly-monday-observance-option` required	string
`timeframe-holiday-array[].timeframe-weekly-tuesday-observance-option` required	string
`timeframe-holiday-array[].timeframe-weekly-wednesday-observance-option` required	string
`timeframe-holiday-array[].timeframe-weekly-thursday-observance-option` required	string
`timeframe-holiday-array[].timeframe-weekly-friday-observance-option` required	string
`timeframe-holiday-array[].timeframe-weekly-saturday-observance-option` required	string
`timeframe-holiday-array[].timeframe-weekly-sunday-observance-option` required	string
`timeframe-holiday-array[].timeframe-workweek-list` required	string
`timeframe-holiday-array[].timeframe-recurrence-type` required	string
`timeframe-holiday-array[].timeframe-recurrence-end-option` required	string
`timeframe-holiday-array[].timeframe-recurrence-end-date` required	string	Timeframe recurrence end (date).
`timeframe-holiday-array[].timeframe-expiry-datetime`	string	Timeframe expiry (date and time).
`timeframe-holiday-array[].domain`	string	The account the item belongs to.
`timeframe-holiday-array[].timeframe-next-observance-datetime`	array of number	Timeframe next observance (date and time).

Example request

curl -X POST "https://api.noodlevoice.com/ns-api/v2/domains/~/timeframes" \
  -H "Authorization: Bearer $NOODLEVOICE_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "synchronous": "yes"
  }'

const res = await fetch("https://api.noodlevoice.com/ns-api/v2/domains/~/timeframes", {
  method: "POST",
  headers: {
    Authorization: "Bearer " + process.env.NOODLEVOICE_KEY,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "synchronous": "yes"
  }),
});
const data = await res.json();

import os, requests

r = requests.post(
    "https://api.noodlevoice.com/ns-api/v2/domains/~/timeframes",
    headers={"Authorization": "Bearer " + os.environ["NOODLEVOICE_KEY"]},
    json={
        "synchronous": "yes"
    },
)
print(r.status_code, r.json())

Response 200

{
  "timeframe-id": "string",
  "timeframe-name": "Front Desk",
  "user": "1001",
  "domain": "string",
  "timeframe-type": "string",
  "timeframe-specific-dates-array": [
    {}
  ],
  "timeframe-holiday-array": [
    {}
  ],
  "timeframe-days-of-week-array": [
    {}
  ]
}

Response fields (96)

Field	Type	Notes
`timeframe-id`	string	The time frame's ID.
`timeframe-name`	string	Name of the time frame.
`user`	string	The user ID (extension).
`domain`	string	The account the item belongs to.
`timeframe-type`	string	What kind of time frame it is.
`timeframe-specific-dates-array`	array of object
`timeframe-specific-dates-array[].timeframe-id`	string	The time frame's ID.
`timeframe-specific-dates-array[].timeframe-parent-id`	string	ID of the timeframe parent.
`timeframe-specific-dates-array[].ordinal-order`	number
`timeframe-specific-dates-array[].timeframe-specific-dates-begin-date`	string	Timeframe specific dates begin (date).
`timeframe-specific-dates-array[].timeframe-specific-dates-begin-time`	string
`timeframe-specific-dates-array[].timeframe-specific-dates-end-date`	string	Timeframe specific dates end (date).
`timeframe-specific-dates-array[].timeframe-specific-dates-end-time`	string
`timeframe-specific-dates-array[].timeframe-recurrence-type`	string
`timeframe-specific-dates-array[].timeframe-recurrence-custom-interval`	string
`timeframe-specific-dates-array[].timeframe-recurrence-custom-interval-count`	string	Number of timeframe recurrence custom interval.
`timeframe-specific-dates-array[].timeframe-recurrence-custom-interval-option`	string
`timeframe-specific-dates-array[].timeframe-recurrence-end-option`	string
`timeframe-specific-dates-array[].timeframe-recurrence-end-date`	string	Timeframe recurrence end (date).
`timeframe-specific-dates-array[].timeframe-expiry-datetime`	string	Timeframe expiry (date and time).
`timeframe-specific-dates-array[].domain`	string	The account the item belongs to.
`timeframe-specific-dates-array[].timeframe-recurrence-rrule`	string
`timeframe-specific-dates-array[].timeframe-next-observance-datetime`	array of number	Timeframe next observance (date and time).
`timeframe-specific-dates-array[].timeframe-is-v1`	boolean
`timeframe-holiday-array`	array of object
`timeframe-holiday-array[].timeframe-id`	string	The time frame's ID.
`timeframe-holiday-array[].timeframe-parent-id`	string	ID of the timeframe parent.
`timeframe-holiday-array[].ordinal-order`	number
`timeframe-holiday-array[].timeframe-holiday-uuid`	string
`timeframe-holiday-array[].timeframe-holiday-name`	string	Name of the timeframe holiday.
`timeframe-holiday-array[].timeframe-holiday-begin-date`	string	Timeframe holiday begin (date).
`timeframe-holiday-array[].country-abbreviation`	string
`timeframe-holiday-array[].state-province-abbreviation`	string
`timeframe-holiday-array[].holiday-api-location-hint`	string
`timeframe-holiday-array[].timeframe-holiday-begin-time-1`	string
`timeframe-holiday-array[].timeframe-holiday-end-time-1`	string
`timeframe-holiday-array[].timeframe-holiday-begin-time-2`	string
`timeframe-holiday-array[].timeframe-holiday-end-time-2`	string
`timeframe-holiday-array[].timeframe-weekly-monday-observance-option`	string
`timeframe-holiday-array[].timeframe-weekly-tuesday-observance-option`	string
`timeframe-holiday-array[].timeframe-weekly-wednesday-observance-option`	string
`timeframe-holiday-array[].timeframe-weekly-thursday-observance-option`	string
`timeframe-holiday-array[].timeframe-weekly-friday-observance-option`	string
`timeframe-holiday-array[].timeframe-weekly-saturday-observance-option`	string
`timeframe-holiday-array[].timeframe-weekly-sunday-observance-option`	string
`timeframe-holiday-array[].timeframe-workweek-list`	string
`timeframe-holiday-array[].timeframe-recurrence-type`	string
`timeframe-holiday-array[].timeframe-recurrence-end-option`	string
`timeframe-holiday-array[].timeframe-recurrence-end-date`	string	Timeframe recurrence end (date).
`timeframe-holiday-array[].timeframe-expiry-datetime`	string	Timeframe expiry (date and time).
`timeframe-holiday-array[].domain`	string	The account the item belongs to.
`timeframe-holiday-array[].timeframe-next-observance-datetime`	array of number	Timeframe next observance (date and time).
`timeframe-days-of-week-array`	array of object
`timeframe-days-of-week-array[].timeframe-id`	string	The time frame's ID.
`timeframe-days-of-week-array[].timeframe-parent-id`	string	ID of the timeframe parent.
`timeframe-days-of-week-array[].ordinal-order`	number
`timeframe-days-of-week-array[].timeframe-weekly-sunday-begin-time-1`	string
`timeframe-days-of-week-array[].timeframe-weekly-sunday-end-time-1`	string
`timeframe-days-of-week-array[].timeframe-weekly-sunday-begin-time-2`	string
`timeframe-days-of-week-array[].timeframe-weekly-sunday-end-time-2`	string
`timeframe-days-of-week-array[].timeframe-weekly-monday-begin-time-1`	string
`timeframe-days-of-week-array[].timeframe-weekly-monday-end-time-1`	string
`timeframe-days-of-week-array[].timeframe-weekly-monday-begin-time-2`	string
`timeframe-days-of-week-array[].timeframe-weekly-monday-end-time-2`	string
`timeframe-days-of-week-array[].timeframe-weekly-tuesday-begin-time-1`	string
`timeframe-days-of-week-array[].timeframe-weekly-tuesday-end-time-1`	string
`timeframe-days-of-week-array[].timeframe-weekly-tuesday-begin-time-2`	string
`timeframe-days-of-week-array[].timeframe-weekly-tuesday-end-time-2`	string
`timeframe-days-of-week-array[].timeframe-weekly-wednesday-begin-time-1`	string
`timeframe-days-of-week-array[].timeframe-weekly-wednesday-end-time-1`	string
`timeframe-days-of-week-array[].timeframe-weekly-wednesday-begin-time-2`	string
`timeframe-days-of-week-array[].timeframe-weekly-wednesday-end-time-2`	string
`timeframe-days-of-week-array[].timeframe-weekly-thursday-begin-time-1`	string
`timeframe-days-of-week-array[].timeframe-weekly-thursday-end-time-1`	string
`timeframe-days-of-week-array[].timeframe-weekly-thursday-begin-time-2`	string
`timeframe-days-of-week-array[].timeframe-weekly-thursday-end-time-2`	string
`timeframe-days-of-week-array[].timeframe-weekly-friday-begin-time-1`	string
`timeframe-days-of-week-array[].timeframe-weekly-friday-end-time-1`	string
`timeframe-days-of-week-array[].timeframe-weekly-friday-begin-time-2`	string
`timeframe-days-of-week-array[].timeframe-weekly-friday-end-time-2`	string
`timeframe-days-of-week-array[].timeframe-weekly-saturday-begin-time-1`	string
`timeframe-days-of-week-array[].timeframe-weekly-saturday-end-time-1`	string
`timeframe-days-of-week-array[].timeframe-weekly-saturday-begin-time-2`	string
`timeframe-days-of-week-array[].timeframe-weekly-saturday-end-time-2`	string
`timeframe-days-of-week-array[].timeframe-recurrence-type`	string
`timeframe-days-of-week-array[].timeframe-recurrence-begin-date`	string	Timeframe recurrence begin (date).
`timeframe-days-of-week-array[].timeframe-recurrence-custom-interval`	string
`timeframe-days-of-week-array[].timeframe-recurrence-custom-interval-count`	string	Number of timeframe recurrence custom interval.
`timeframe-days-of-week-array[].timeframe-recurrence-custom-interval-option`	string
`timeframe-days-of-week-array[].timeframe-recurrence-end-option`	string
`timeframe-days-of-week-array[].timeframe-recurrence-end-date`	string	Timeframe recurrence end (date).
`timeframe-days-of-week-array[].timeframe-expiry-datetime`	string	Timeframe expiry (date and time).
`timeframe-days-of-week-array[].domain`	string	The account the item belongs to.
`timeframe-days-of-week-array[].timeframe-next-observance-datetime`	array of number	Timeframe next observance (date and time).
`timeframe-days-of-week-array[].timeframe-recurrence-rrule`	string
`timeframe-days-of-week-array[].timeframe-is-v1`	boolean

Create a custom time frame

POST/domains/~/timeframes

Adds a shared time frame that mixes date ranges, weekly hours and holidays.

Write Key Admin switch: Schedules (time frames), Write.

Request body application/json

Field	Type	Notes
`synchronous` required	string	Set to `yes` to wait until the change is finished before the response comes back. One of: `yes`, `no` Default `no`
`timeframe-name`	string	Name of the time frame.
`timeframe-type`	string	What kind of time frame it is.
`timeframe-specific-dates-array`	array of object
`timeframe-specific-dates-array[].timeframe-id`	string	The time frame's ID.
`timeframe-specific-dates-array[].timeframe-parent-id`	string	ID of the timeframe parent.
`timeframe-specific-dates-array[].ordinal-order`	number
`timeframe-specific-dates-array[].timeframe-specific-dates-begin-date` required	string	Timeframe specific dates begin (date).
`timeframe-specific-dates-array[].timeframe-specific-dates-begin-time` required	string
`timeframe-specific-dates-array[].timeframe-specific-dates-end-date` required	string	Timeframe specific dates end (date).
`timeframe-specific-dates-array[].timeframe-specific-dates-end-time` required	string
`timeframe-specific-dates-array[].timeframe-recurrence-type` required	string
`timeframe-specific-dates-array[].timeframe-recurrence-custom-interval` required	string
`timeframe-specific-dates-array[].timeframe-recurrence-custom-interval-count` required	string	Number of timeframe recurrence custom interval.
`timeframe-specific-dates-array[].timeframe-recurrence-custom-interval-option` required	string
`timeframe-specific-dates-array[].timeframe-recurrence-end-option` required	string
`timeframe-specific-dates-array[].timeframe-recurrence-end-date` required	string	Timeframe recurrence end (date).
`timeframe-specific-dates-array[].timeframe-expiry-datetime`	string	Timeframe expiry (date and time).
`timeframe-specific-dates-array[].domain`	string	The account the item belongs to.
`timeframe-specific-dates-array[].timeframe-recurrence-rrule`	string
`timeframe-specific-dates-array[].timeframe-next-observance-datetime`	array of number	Timeframe next observance (date and time).
`timeframe-specific-dates-array[].timeframe-is-v1`	boolean
`timeframe-holiday-array`	array of object
`timeframe-holiday-array[].timeframe-id`	string	The time frame's ID.
`timeframe-holiday-array[].timeframe-parent-id`	string	ID of the timeframe parent.
`timeframe-holiday-array[].ordinal-order`	number
`timeframe-holiday-array[].timeframe-holiday-uuid` required	string
`timeframe-holiday-array[].timeframe-holiday-name` required	string	Name of the timeframe holiday.
`timeframe-holiday-array[].timeframe-holiday-begin-date` required	string	Timeframe holiday begin (date).
`timeframe-holiday-array[].country-abbreviation` required	string
`timeframe-holiday-array[].state-province-abbreviation` required	string
`timeframe-holiday-array[].holiday-api-location-hint` required	string
`timeframe-holiday-array[].timeframe-holiday-begin-time-1` required	string
`timeframe-holiday-array[].timeframe-holiday-end-time-1` required	string
`timeframe-holiday-array[].timeframe-holiday-begin-time-2` required	string
`timeframe-holiday-array[].timeframe-holiday-end-time-2` required	string
`timeframe-holiday-array[].timeframe-weekly-monday-observance-option` required	string
`timeframe-holiday-array[].timeframe-weekly-tuesday-observance-option` required	string
`timeframe-holiday-array[].timeframe-weekly-wednesday-observance-option` required	string
`timeframe-holiday-array[].timeframe-weekly-thursday-observance-option` required	string
`timeframe-holiday-array[].timeframe-weekly-friday-observance-option` required	string
`timeframe-holiday-array[].timeframe-weekly-saturday-observance-option` required	string
`timeframe-holiday-array[].timeframe-weekly-sunday-observance-option` required	string
`timeframe-holiday-array[].timeframe-workweek-list` required	string
`timeframe-holiday-array[].timeframe-recurrence-type` required	string
`timeframe-holiday-array[].timeframe-recurrence-end-option` required	string
`timeframe-holiday-array[].timeframe-recurrence-end-date` required	string	Timeframe recurrence end (date).
`timeframe-holiday-array[].timeframe-expiry-datetime`	string	Timeframe expiry (date and time).
`timeframe-holiday-array[].domain`	string	The account the item belongs to.
`timeframe-holiday-array[].timeframe-next-observance-datetime`	array of number	Timeframe next observance (date and time).
`timeframe-days-of-week-array`	array of object
`timeframe-days-of-week-array[].timeframe-id`	string	The time frame's ID.
`timeframe-days-of-week-array[].timeframe-parent-id`	string	ID of the timeframe parent.
`timeframe-days-of-week-array[].ordinal-order`	number
`timeframe-days-of-week-array[].timeframe-weekly-sunday-begin-time-1`	string
`timeframe-days-of-week-array[].timeframe-weekly-sunday-end-time-1`	string
`timeframe-days-of-week-array[].timeframe-weekly-sunday-begin-time-2`	string
`timeframe-days-of-week-array[].timeframe-weekly-sunday-end-time-2`	string
`timeframe-days-of-week-array[].timeframe-weekly-monday-begin-time-1`	string
`timeframe-days-of-week-array[].timeframe-weekly-monday-end-time-1`	string
`timeframe-days-of-week-array[].timeframe-weekly-monday-begin-time-2`	string
`timeframe-days-of-week-array[].timeframe-weekly-monday-end-time-2`	string
`timeframe-days-of-week-array[].timeframe-weekly-tuesday-begin-time-1`	string
`timeframe-days-of-week-array[].timeframe-weekly-tuesday-end-time-1`	string
`timeframe-days-of-week-array[].timeframe-weekly-tuesday-begin-time-2`	string
`timeframe-days-of-week-array[].timeframe-weekly-tuesday-end-time-2`	string
`timeframe-days-of-week-array[].timeframe-weekly-wednesday-begin-time-1`	string
`timeframe-days-of-week-array[].timeframe-weekly-wednesday-end-time-1`	string
`timeframe-days-of-week-array[].timeframe-weekly-wednesday-begin-time-2`	string
`timeframe-days-of-week-array[].timeframe-weekly-wednesday-end-time-2`	string
`timeframe-days-of-week-array[].timeframe-weekly-thursday-begin-time-1`	string
`timeframe-days-of-week-array[].timeframe-weekly-thursday-end-time-1`	string
`timeframe-days-of-week-array[].timeframe-weekly-thursday-begin-time-2`	string
`timeframe-days-of-week-array[].timeframe-weekly-thursday-end-time-2`	string
`timeframe-days-of-week-array[].timeframe-weekly-friday-begin-time-1`	string
`timeframe-days-of-week-array[].timeframe-weekly-friday-end-time-1`	string
`timeframe-days-of-week-array[].timeframe-weekly-friday-begin-time-2`	string
`timeframe-days-of-week-array[].timeframe-weekly-friday-end-time-2`	string
`timeframe-days-of-week-array[].timeframe-weekly-saturday-begin-time-1`	string
`timeframe-days-of-week-array[].timeframe-weekly-saturday-end-time-1`	string
`timeframe-days-of-week-array[].timeframe-weekly-saturday-begin-time-2`	string
`timeframe-days-of-week-array[].timeframe-weekly-saturday-end-time-2`	string
`timeframe-days-of-week-array[].timeframe-recurrence-type` required	string
`timeframe-days-of-week-array[].timeframe-recurrence-begin-date` required	string	Timeframe recurrence begin (date).
`timeframe-days-of-week-array[].timeframe-recurrence-custom-interval` required	string
`timeframe-days-of-week-array[].timeframe-recurrence-custom-interval-count` required	string	Number of timeframe recurrence custom interval.
`timeframe-days-of-week-array[].timeframe-recurrence-custom-interval-option` required	string
`timeframe-days-of-week-array[].timeframe-recurrence-end-option` required	string
`timeframe-days-of-week-array[].timeframe-recurrence-end-date` required	string	Timeframe recurrence end (date).
`timeframe-days-of-week-array[].timeframe-expiry-datetime`	string	Timeframe expiry (date and time).
`timeframe-days-of-week-array[].domain`	string	The account the item belongs to.
`timeframe-days-of-week-array[].timeframe-next-observance-datetime`	array of number	Timeframe next observance (date and time).
`timeframe-days-of-week-array[].timeframe-recurrence-rrule`	string
`timeframe-days-of-week-array[].timeframe-is-v1`	boolean

Example request

curl -X POST "https://api.noodlevoice.com/ns-api/v2/domains/~/timeframes" \
  -H "Authorization: Bearer $NOODLEVOICE_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "synchronous": "yes"
  }'

const res = await fetch("https://api.noodlevoice.com/ns-api/v2/domains/~/timeframes", {
  method: "POST",
  headers: {
    Authorization: "Bearer " + process.env.NOODLEVOICE_KEY,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "synchronous": "yes"
  }),
});
const data = await res.json();

import os, requests

r = requests.post(
    "https://api.noodlevoice.com/ns-api/v2/domains/~/timeframes",
    headers={"Authorization": "Bearer " + os.environ["NOODLEVOICE_KEY"]},
    json={
        "synchronous": "yes"
    },
)
print(r.status_code, r.json())

Response 200

Returns a status code with a short JSON message.

Create an always time frame

POST/domains/~/timeframes

Adds a shared time frame that is always active. Useful as the catch-all answer rule.

Write Key Admin switch: Schedules (time frames), Write.

Request body application/json

Field	Type	Notes
`synchronous` required	string	Set to `yes` to wait until the change is finished before the response comes back. One of: `yes`, `no` Default `no`
`timeframe-name`	string	Name of the time frame.
`timeframe-type`	string	What kind of time frame it is.

Example request

curl -X POST "https://api.noodlevoice.com/ns-api/v2/domains/~/timeframes" \
  -H "Authorization: Bearer $NOODLEVOICE_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "synchronous": "yes"
  }'

const res = await fetch("https://api.noodlevoice.com/ns-api/v2/domains/~/timeframes", {
  method: "POST",
  headers: {
    Authorization: "Bearer " + process.env.NOODLEVOICE_KEY,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "synchronous": "yes"
  }),
});
const data = await res.json();

import os, requests

r = requests.post(
    "https://api.noodlevoice.com/ns-api/v2/domains/~/timeframes",
    headers={"Authorization": "Bearer " + os.environ["NOODLEVOICE_KEY"]},
    json={
        "synchronous": "yes"
    },
)
print(r.status_code, r.json())

Response 200

{
  "timeframe-id": "string",
  "timeframe-name": "Front Desk",
  "user": "1001",
  "domain": "string",
  "timeframe-type": "string",
  "timeframe-specific-dates-array": [
    {}
  ],
  "timeframe-holiday-array": [
    {}
  ],
  "timeframe-days-of-week-array": [
    {}
  ]
}

Response fields (96)

Field	Type	Notes
`timeframe-id`	string	The time frame's ID.
`timeframe-name`	string	Name of the time frame.
`user`	string	The user ID (extension).
`domain`	string	The account the item belongs to.
`timeframe-type`	string	What kind of time frame it is.
`timeframe-specific-dates-array`	array of object
`timeframe-specific-dates-array[].timeframe-id`	string	The time frame's ID.
`timeframe-specific-dates-array[].timeframe-parent-id`	string	ID of the timeframe parent.
`timeframe-specific-dates-array[].ordinal-order`	number
`timeframe-specific-dates-array[].timeframe-specific-dates-begin-date`	string	Timeframe specific dates begin (date).
`timeframe-specific-dates-array[].timeframe-specific-dates-begin-time`	string
`timeframe-specific-dates-array[].timeframe-specific-dates-end-date`	string	Timeframe specific dates end (date).
`timeframe-specific-dates-array[].timeframe-specific-dates-end-time`	string
`timeframe-specific-dates-array[].timeframe-recurrence-type`	string
`timeframe-specific-dates-array[].timeframe-recurrence-custom-interval`	string
`timeframe-specific-dates-array[].timeframe-recurrence-custom-interval-count`	string	Number of timeframe recurrence custom interval.
`timeframe-specific-dates-array[].timeframe-recurrence-custom-interval-option`	string
`timeframe-specific-dates-array[].timeframe-recurrence-end-option`	string
`timeframe-specific-dates-array[].timeframe-recurrence-end-date`	string	Timeframe recurrence end (date).
`timeframe-specific-dates-array[].timeframe-expiry-datetime`	string	Timeframe expiry (date and time).
`timeframe-specific-dates-array[].domain`	string	The account the item belongs to.
`timeframe-specific-dates-array[].timeframe-recurrence-rrule`	string
`timeframe-specific-dates-array[].timeframe-next-observance-datetime`	array of number	Timeframe next observance (date and time).
`timeframe-specific-dates-array[].timeframe-is-v1`	boolean
`timeframe-holiday-array`	array of object
`timeframe-holiday-array[].timeframe-id`	string	The time frame's ID.
`timeframe-holiday-array[].timeframe-parent-id`	string	ID of the timeframe parent.
`timeframe-holiday-array[].ordinal-order`	number
`timeframe-holiday-array[].timeframe-holiday-uuid`	string
`timeframe-holiday-array[].timeframe-holiday-name`	string	Name of the timeframe holiday.
`timeframe-holiday-array[].timeframe-holiday-begin-date`	string	Timeframe holiday begin (date).
`timeframe-holiday-array[].country-abbreviation`	string
`timeframe-holiday-array[].state-province-abbreviation`	string
`timeframe-holiday-array[].holiday-api-location-hint`	string
`timeframe-holiday-array[].timeframe-holiday-begin-time-1`	string
`timeframe-holiday-array[].timeframe-holiday-end-time-1`	string
`timeframe-holiday-array[].timeframe-holiday-begin-time-2`	string
`timeframe-holiday-array[].timeframe-holiday-end-time-2`	string
`timeframe-holiday-array[].timeframe-weekly-monday-observance-option`	string
`timeframe-holiday-array[].timeframe-weekly-tuesday-observance-option`	string
`timeframe-holiday-array[].timeframe-weekly-wednesday-observance-option`	string
`timeframe-holiday-array[].timeframe-weekly-thursday-observance-option`	string
`timeframe-holiday-array[].timeframe-weekly-friday-observance-option`	string
`timeframe-holiday-array[].timeframe-weekly-saturday-observance-option`	string
`timeframe-holiday-array[].timeframe-weekly-sunday-observance-option`	string
`timeframe-holiday-array[].timeframe-workweek-list`	string
`timeframe-holiday-array[].timeframe-recurrence-type`	string
`timeframe-holiday-array[].timeframe-recurrence-end-option`	string
`timeframe-holiday-array[].timeframe-recurrence-end-date`	string	Timeframe recurrence end (date).
`timeframe-holiday-array[].timeframe-expiry-datetime`	string	Timeframe expiry (date and time).
`timeframe-holiday-array[].domain`	string	The account the item belongs to.
`timeframe-holiday-array[].timeframe-next-observance-datetime`	array of number	Timeframe next observance (date and time).
`timeframe-days-of-week-array`	array of object
`timeframe-days-of-week-array[].timeframe-id`	string	The time frame's ID.
`timeframe-days-of-week-array[].timeframe-parent-id`	string	ID of the timeframe parent.
`timeframe-days-of-week-array[].ordinal-order`	number
`timeframe-days-of-week-array[].timeframe-weekly-sunday-begin-time-1`	string
`timeframe-days-of-week-array[].timeframe-weekly-sunday-end-time-1`	string
`timeframe-days-of-week-array[].timeframe-weekly-sunday-begin-time-2`	string
`timeframe-days-of-week-array[].timeframe-weekly-sunday-end-time-2`	string
`timeframe-days-of-week-array[].timeframe-weekly-monday-begin-time-1`	string
`timeframe-days-of-week-array[].timeframe-weekly-monday-end-time-1`	string
`timeframe-days-of-week-array[].timeframe-weekly-monday-begin-time-2`	string
`timeframe-days-of-week-array[].timeframe-weekly-monday-end-time-2`	string
`timeframe-days-of-week-array[].timeframe-weekly-tuesday-begin-time-1`	string
`timeframe-days-of-week-array[].timeframe-weekly-tuesday-end-time-1`	string
`timeframe-days-of-week-array[].timeframe-weekly-tuesday-begin-time-2`	string
`timeframe-days-of-week-array[].timeframe-weekly-tuesday-end-time-2`	string
`timeframe-days-of-week-array[].timeframe-weekly-wednesday-begin-time-1`	string
`timeframe-days-of-week-array[].timeframe-weekly-wednesday-end-time-1`	string
`timeframe-days-of-week-array[].timeframe-weekly-wednesday-begin-time-2`	string
`timeframe-days-of-week-array[].timeframe-weekly-wednesday-end-time-2`	string
`timeframe-days-of-week-array[].timeframe-weekly-thursday-begin-time-1`	string
`timeframe-days-of-week-array[].timeframe-weekly-thursday-end-time-1`	string
`timeframe-days-of-week-array[].timeframe-weekly-thursday-begin-time-2`	string
`timeframe-days-of-week-array[].timeframe-weekly-thursday-end-time-2`	string
`timeframe-days-of-week-array[].timeframe-weekly-friday-begin-time-1`	string
`timeframe-days-of-week-array[].timeframe-weekly-friday-end-time-1`	string
`timeframe-days-of-week-array[].timeframe-weekly-friday-begin-time-2`	string
`timeframe-days-of-week-array[].timeframe-weekly-friday-end-time-2`	string
`timeframe-days-of-week-array[].timeframe-weekly-saturday-begin-time-1`	string
`timeframe-days-of-week-array[].timeframe-weekly-saturday-end-time-1`	string
`timeframe-days-of-week-array[].timeframe-weekly-saturday-begin-time-2`	string
`timeframe-days-of-week-array[].timeframe-weekly-saturday-end-time-2`	string
`timeframe-days-of-week-array[].timeframe-recurrence-type`	string
`timeframe-days-of-week-array[].timeframe-recurrence-begin-date`	string	Timeframe recurrence begin (date).
`timeframe-days-of-week-array[].timeframe-recurrence-custom-interval`	string
`timeframe-days-of-week-array[].timeframe-recurrence-custom-interval-count`	string	Number of timeframe recurrence custom interval.
`timeframe-days-of-week-array[].timeframe-recurrence-custom-interval-option`	string
`timeframe-days-of-week-array[].timeframe-recurrence-end-option`	string
`timeframe-days-of-week-array[].timeframe-recurrence-end-date`	string	Timeframe recurrence end (date).
`timeframe-days-of-week-array[].timeframe-expiry-datetime`	string	Timeframe expiry (date and time).
`timeframe-days-of-week-array[].domain`	string	The account the item belongs to.
`timeframe-days-of-week-array[].timeframe-next-observance-datetime`	array of number	Timeframe next observance (date and time).
`timeframe-days-of-week-array[].timeframe-recurrence-rrule`	string
`timeframe-days-of-week-array[].timeframe-is-v1`	boolean

Add holidays to a time frame

POST/domains/~/timeframes/{id}

Adds more holidays to a holidays time frame.

Write Key Admin switch: Schedules (time frames), Write.

Parameters

Name	In	Type	Notes
`id` required	path	string	The ID of the item, as returned when you list or create it.

Request body application/json

Field	Type	Notes
`timeframe-holiday-array`	array of object
`timeframe-holiday-array[].timeframe-id`	string	The time frame's ID.
`timeframe-holiday-array[].timeframe-parent-id`	string	ID of the timeframe parent.
`timeframe-holiday-array[].ordinal-order`	number
`timeframe-holiday-array[].timeframe-holiday-uuid` required	string
`timeframe-holiday-array[].timeframe-holiday-name` required	string	Name of the timeframe holiday.
`timeframe-holiday-array[].timeframe-holiday-begin-date` required	string	Timeframe holiday begin (date).
`timeframe-holiday-array[].country-abbreviation` required	string
`timeframe-holiday-array[].state-province-abbreviation` required	string
`timeframe-holiday-array[].holiday-api-location-hint` required	string
`timeframe-holiday-array[].timeframe-holiday-begin-time-1` required	string
`timeframe-holiday-array[].timeframe-holiday-end-time-1` required	string
`timeframe-holiday-array[].timeframe-holiday-begin-time-2` required	string
`timeframe-holiday-array[].timeframe-holiday-end-time-2` required	string
`timeframe-holiday-array[].timeframe-weekly-monday-observance-option` required	string
`timeframe-holiday-array[].timeframe-weekly-tuesday-observance-option` required	string
`timeframe-holiday-array[].timeframe-weekly-wednesday-observance-option` required	string
`timeframe-holiday-array[].timeframe-weekly-thursday-observance-option` required	string
`timeframe-holiday-array[].timeframe-weekly-friday-observance-option` required	string
`timeframe-holiday-array[].timeframe-weekly-saturday-observance-option` required	string
`timeframe-holiday-array[].timeframe-weekly-sunday-observance-option` required	string
`timeframe-holiday-array[].timeframe-workweek-list` required	string
`timeframe-holiday-array[].timeframe-recurrence-type` required	string
`timeframe-holiday-array[].timeframe-recurrence-end-option` required	string
`timeframe-holiday-array[].timeframe-recurrence-end-date` required	string	Timeframe recurrence end (date).
`timeframe-holiday-array[].timeframe-expiry-datetime`	string	Timeframe expiry (date and time).
`timeframe-holiday-array[].domain`	string	The account the item belongs to.
`timeframe-holiday-array[].timeframe-next-observance-datetime`	array of number	Timeframe next observance (date and time).

Example request

curl -X POST "https://api.noodlevoice.com/ns-api/v2/domains/~/timeframes/{id}" \
  -H "Authorization: Bearer $NOODLEVOICE_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "timeframe-holiday-array": [
      {
        "timeframe-holiday-uuid": "string",
        "timeframe-holiday-name": "Front Desk",
        "timeframe-holiday-begin-date": "2026-11-02",
        "country-abbreviation": "string",
        "state-province-abbreviation": "string",
        "holiday-api-location-hint": "string",
        "timeframe-holiday-begin-time-1": "string",
        "timeframe-holiday-end-time-1": "string",
        "timeframe-holiday-begin-time-2": "string",
        "timeframe-holiday-end-time-2": "string",
        "timeframe-weekly-monday-observance-option": "string",
        "timeframe-weekly-tuesday-observance-option": "string",
        "timeframe-weekly-wednesday-observance-option": "string",
        "timeframe-weekly-thursday-observance-option": "string",
        "timeframe-weekly-friday-observance-option": "string",
        "timeframe-weekly-saturday-observance-option": "string",
        "timeframe-weekly-sunday-observance-option": "string",
        "timeframe-workweek-list": "string",
        "timeframe-recurrence-type": "string",
        "timeframe-recurrence-end-option": "string",
        "timeframe-recurrence-end-date": "2026-11-02"
      }
    ]
  }'

const res = await fetch("https://api.noodlevoice.com/ns-api/v2/domains/~/timeframes/{id}", {
  method: "POST",
  headers: {
    Authorization: "Bearer " + process.env.NOODLEVOICE_KEY,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "timeframe-holiday-array": [
      {
        "timeframe-holiday-uuid": "string",
        "timeframe-holiday-name": "Front Desk",
        "timeframe-holiday-begin-date": "2026-11-02",
        "country-abbreviation": "string",
        "state-province-abbreviation": "string",
        "holiday-api-location-hint": "string",
        "timeframe-holiday-begin-time-1": "string",
        "timeframe-holiday-end-time-1": "string",
        "timeframe-holiday-begin-time-2": "string",
        "timeframe-holiday-end-time-2": "string",
        "timeframe-weekly-monday-observance-option": "string",
        "timeframe-weekly-tuesday-observance-option": "string",
        "timeframe-weekly-wednesday-observance-option": "string",
        "timeframe-weekly-thursday-observance-option": "string",
        "timeframe-weekly-friday-observance-option": "string",
        "timeframe-weekly-saturday-observance-option": "string",
        "timeframe-weekly-sunday-observance-option": "string",
        "timeframe-workweek-list": "string",
        "timeframe-recurrence-type": "string",
        "timeframe-recurrence-end-option": "string",
        "timeframe-recurrence-end-date": "2026-11-02"
      }
    ]
  }),
});
const data = await res.json();

import os, requests

r = requests.post(
    "https://api.noodlevoice.com/ns-api/v2/domains/~/timeframes/{id}",
    headers={"Authorization": "Bearer " + os.environ["NOODLEVOICE_KEY"]},
    json={
        "timeframe-holiday-array": [
            {
                "timeframe-holiday-uuid": "string",
                "timeframe-holiday-name": "Front Desk",
                "timeframe-holiday-begin-date": "2026-11-02",
                "country-abbreviation": "string",
                "state-province-abbreviation": "string",
                "holiday-api-location-hint": "string",
                "timeframe-holiday-begin-time-1": "string",
                "timeframe-holiday-end-time-1": "string",
                "timeframe-holiday-begin-time-2": "string",
                "timeframe-holiday-end-time-2": "string",
                "timeframe-weekly-monday-observance-option": "string",
                "timeframe-weekly-tuesday-observance-option": "string",
                "timeframe-weekly-wednesday-observance-option": "string",
                "timeframe-weekly-thursday-observance-option": "string",
                "timeframe-weekly-friday-observance-option": "string",
                "timeframe-weekly-saturday-observance-option": "string",
                "timeframe-weekly-sunday-observance-option": "string",
                "timeframe-workweek-list": "string",
                "timeframe-recurrence-type": "string",
                "timeframe-recurrence-end-option": "string",
                "timeframe-recurrence-end-date": "2026-11-02"
            }
        ]
    },
)
print(r.status_code, r.json())

Response 202

Returns a status code with a short JSON message.

Other responses: 400, 401, 404. See errors.

Add entries to a custom time frame

POST/domains/~/timeframes/{id}

Adds more date ranges, weekly hours or holidays to a custom time frame.

Write Key Admin switch: Schedules (time frames), Write.

Parameters

Name	In	Type	Notes
`id` required	path	string	The ID of the item, as returned when you list or create it.

Request body application/json

Field	Type	Notes
`timeframe-specific-dates-array`	array of object
`timeframe-specific-dates-array[].timeframe-id`	string	The time frame's ID.
`timeframe-specific-dates-array[].timeframe-parent-id`	string	ID of the timeframe parent.
`timeframe-specific-dates-array[].ordinal-order`	number
`timeframe-specific-dates-array[].timeframe-specific-dates-begin-date` required	string	Timeframe specific dates begin (date).
`timeframe-specific-dates-array[].timeframe-specific-dates-begin-time` required	string
`timeframe-specific-dates-array[].timeframe-specific-dates-end-date` required	string	Timeframe specific dates end (date).
`timeframe-specific-dates-array[].timeframe-specific-dates-end-time` required	string
`timeframe-specific-dates-array[].timeframe-recurrence-type` required	string
`timeframe-specific-dates-array[].timeframe-recurrence-custom-interval` required	string
`timeframe-specific-dates-array[].timeframe-recurrence-custom-interval-count` required	string	Number of timeframe recurrence custom interval.
`timeframe-specific-dates-array[].timeframe-recurrence-custom-interval-option` required	string
`timeframe-specific-dates-array[].timeframe-recurrence-end-option` required	string
`timeframe-specific-dates-array[].timeframe-recurrence-end-date` required	string	Timeframe recurrence end (date).
`timeframe-specific-dates-array[].timeframe-expiry-datetime`	string	Timeframe expiry (date and time).
`timeframe-specific-dates-array[].domain`	string	The account the item belongs to.
`timeframe-specific-dates-array[].timeframe-recurrence-rrule`	string
`timeframe-specific-dates-array[].timeframe-next-observance-datetime`	array of number	Timeframe next observance (date and time).
`timeframe-specific-dates-array[].timeframe-is-v1`	boolean
`timeframe-holiday-array`	array of object
`timeframe-holiday-array[].timeframe-id`	string	The time frame's ID.
`timeframe-holiday-array[].timeframe-parent-id`	string	ID of the timeframe parent.
`timeframe-holiday-array[].ordinal-order`	number
`timeframe-holiday-array[].timeframe-holiday-uuid` required	string
`timeframe-holiday-array[].timeframe-holiday-name` required	string	Name of the timeframe holiday.
`timeframe-holiday-array[].timeframe-holiday-begin-date` required	string	Timeframe holiday begin (date).
`timeframe-holiday-array[].country-abbreviation` required	string
`timeframe-holiday-array[].state-province-abbreviation` required	string
`timeframe-holiday-array[].holiday-api-location-hint` required	string
`timeframe-holiday-array[].timeframe-holiday-begin-time-1` required	string
`timeframe-holiday-array[].timeframe-holiday-end-time-1` required	string
`timeframe-holiday-array[].timeframe-holiday-begin-time-2` required	string
`timeframe-holiday-array[].timeframe-holiday-end-time-2` required	string
`timeframe-holiday-array[].timeframe-weekly-monday-observance-option` required	string
`timeframe-holiday-array[].timeframe-weekly-tuesday-observance-option` required	string
`timeframe-holiday-array[].timeframe-weekly-wednesday-observance-option` required	string
`timeframe-holiday-array[].timeframe-weekly-thursday-observance-option` required	string
`timeframe-holiday-array[].timeframe-weekly-friday-observance-option` required	string
`timeframe-holiday-array[].timeframe-weekly-saturday-observance-option` required	string
`timeframe-holiday-array[].timeframe-weekly-sunday-observance-option` required	string
`timeframe-holiday-array[].timeframe-workweek-list` required	string
`timeframe-holiday-array[].timeframe-recurrence-type` required	string
`timeframe-holiday-array[].timeframe-recurrence-end-option` required	string
`timeframe-holiday-array[].timeframe-recurrence-end-date` required	string	Timeframe recurrence end (date).
`timeframe-holiday-array[].timeframe-expiry-datetime`	string	Timeframe expiry (date and time).
`timeframe-holiday-array[].domain`	string	The account the item belongs to.
`timeframe-holiday-array[].timeframe-next-observance-datetime`	array of number	Timeframe next observance (date and time).
`timeframe-days-of-week-array`	array of object
`timeframe-days-of-week-array[].timeframe-id`	string	The time frame's ID.
`timeframe-days-of-week-array[].timeframe-parent-id`	string	ID of the timeframe parent.
`timeframe-days-of-week-array[].ordinal-order`	number
`timeframe-days-of-week-array[].timeframe-weekly-sunday-begin-time-1`	string
`timeframe-days-of-week-array[].timeframe-weekly-sunday-end-time-1`	string
`timeframe-days-of-week-array[].timeframe-weekly-sunday-begin-time-2`	string
`timeframe-days-of-week-array[].timeframe-weekly-sunday-end-time-2`	string
`timeframe-days-of-week-array[].timeframe-weekly-monday-begin-time-1`	string
`timeframe-days-of-week-array[].timeframe-weekly-monday-end-time-1`	string
`timeframe-days-of-week-array[].timeframe-weekly-monday-begin-time-2`	string
`timeframe-days-of-week-array[].timeframe-weekly-monday-end-time-2`	string
`timeframe-days-of-week-array[].timeframe-weekly-tuesday-begin-time-1`	string
`timeframe-days-of-week-array[].timeframe-weekly-tuesday-end-time-1`	string
`timeframe-days-of-week-array[].timeframe-weekly-tuesday-begin-time-2`	string
`timeframe-days-of-week-array[].timeframe-weekly-tuesday-end-time-2`	string
`timeframe-days-of-week-array[].timeframe-weekly-wednesday-begin-time-1`	string
`timeframe-days-of-week-array[].timeframe-weekly-wednesday-end-time-1`	string
`timeframe-days-of-week-array[].timeframe-weekly-wednesday-begin-time-2`	string
`timeframe-days-of-week-array[].timeframe-weekly-wednesday-end-time-2`	string
`timeframe-days-of-week-array[].timeframe-weekly-thursday-begin-time-1`	string
`timeframe-days-of-week-array[].timeframe-weekly-thursday-end-time-1`	string
`timeframe-days-of-week-array[].timeframe-weekly-thursday-begin-time-2`	string
`timeframe-days-of-week-array[].timeframe-weekly-thursday-end-time-2`	string
`timeframe-days-of-week-array[].timeframe-weekly-friday-begin-time-1`	string
`timeframe-days-of-week-array[].timeframe-weekly-friday-end-time-1`	string
`timeframe-days-of-week-array[].timeframe-weekly-friday-begin-time-2`	string
`timeframe-days-of-week-array[].timeframe-weekly-friday-end-time-2`	string
`timeframe-days-of-week-array[].timeframe-weekly-saturday-begin-time-1`	string
`timeframe-days-of-week-array[].timeframe-weekly-saturday-end-time-1`	string
`timeframe-days-of-week-array[].timeframe-weekly-saturday-begin-time-2`	string
`timeframe-days-of-week-array[].timeframe-weekly-saturday-end-time-2`	string
`timeframe-days-of-week-array[].timeframe-recurrence-type` required	string
`timeframe-days-of-week-array[].timeframe-recurrence-begin-date` required	string	Timeframe recurrence begin (date).
`timeframe-days-of-week-array[].timeframe-recurrence-custom-interval` required	string
`timeframe-days-of-week-array[].timeframe-recurrence-custom-interval-count` required	string	Number of timeframe recurrence custom interval.
`timeframe-days-of-week-array[].timeframe-recurrence-custom-interval-option` required	string
`timeframe-days-of-week-array[].timeframe-recurrence-end-option` required	string
`timeframe-days-of-week-array[].timeframe-recurrence-end-date` required	string	Timeframe recurrence end (date).
`timeframe-days-of-week-array[].timeframe-expiry-datetime`	string	Timeframe expiry (date and time).
`timeframe-days-of-week-array[].domain`	string	The account the item belongs to.
`timeframe-days-of-week-array[].timeframe-next-observance-datetime`	array of number	Timeframe next observance (date and time).
`timeframe-days-of-week-array[].timeframe-recurrence-rrule`	string
`timeframe-days-of-week-array[].timeframe-is-v1`	boolean

Example request

curl -X POST "https://api.noodlevoice.com/ns-api/v2/domains/~/timeframes/{id}" \
  -H "Authorization: Bearer $NOODLEVOICE_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "timeframe-specific-dates-array": [
      {
        "timeframe-specific-dates-begin-date": "2026-11-02",
        "timeframe-specific-dates-begin-time": "string",
        "timeframe-specific-dates-end-date": "2026-11-02",
        "timeframe-specific-dates-end-time": "string",
        "timeframe-recurrence-type": "string",
        "timeframe-recurrence-custom-interval-count": "string",
        "timeframe-recurrence-custom-interval": "string",
        "timeframe-recurrence-custom-interval-option": "string",
        "timeframe-recurrence-end-option": "string",
        "timeframe-recurrence-end-date": "2026-11-02"
      }
    ],
    "timeframe-holiday-array": [
      {
        "timeframe-holiday-uuid": "string",
        "timeframe-holiday-name": "Front Desk",
        "timeframe-holiday-begin-date": "2026-11-02",
        "country-abbreviation": "string",
        "state-province-abbreviation": "string",
        "holiday-api-location-hint": "string",
        "timeframe-holiday-begin-time-1": "string",
        "timeframe-holiday-end-time-1": "string",
        "timeframe-holiday-begin-time-2": "string",
        "timeframe-holiday-end-time-2": "string",
        "timeframe-weekly-monday-observance-option": "string",
        "timeframe-weekly-tuesday-observance-option": "string",
        "timeframe-weekly-wednesday-observance-option": "string",
        "timeframe-weekly-thursday-observance-option": "string",
        "timeframe-weekly-friday-observance-option": "string",
        "timeframe-weekly-saturday-observance-option": "string",
        "timeframe-weekly-sunday-observance-option": "string",
        "timeframe-workweek-list": "string",
        "timeframe-recurrence-type": "string",
        "timeframe-recurrence-end-option": "string",
        "timeframe-recurrence-end-date": "2026-11-02"
      }
    ],
    "timeframe-days-of-week-array": [
      {
        "timeframe-recurrence-begin-date": "2026-11-02",
        "timeframe-recurrence-type": "string",
        "timeframe-recurrence-custom-interval-count": "string",
        "timeframe-recurrence-custom-interval": "string",
        "timeframe-recurrence-custom-interval-option": "string",
        "timeframe-recurrence-end-option": "string",
        "timeframe-recurrence-end-date": "2026-11-02"
      }
    ]
  }'

const res = await fetch("https://api.noodlevoice.com/ns-api/v2/domains/~/timeframes/{id}", {
  method: "POST",
  headers: {
    Authorization: "Bearer " + process.env.NOODLEVOICE_KEY,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "timeframe-specific-dates-array": [
      {
        "timeframe-specific-dates-begin-date": "2026-11-02",
        "timeframe-specific-dates-begin-time": "string",
        "timeframe-specific-dates-end-date": "2026-11-02",
        "timeframe-specific-dates-end-time": "string",
        "timeframe-recurrence-type": "string",
        "timeframe-recurrence-custom-interval-count": "string",
        "timeframe-recurrence-custom-interval": "string",
        "timeframe-recurrence-custom-interval-option": "string",
        "timeframe-recurrence-end-option": "string",
        "timeframe-recurrence-end-date": "2026-11-02"
      }
    ],
    "timeframe-holiday-array": [
      {
        "timeframe-holiday-uuid": "string",
        "timeframe-holiday-name": "Front Desk",
        "timeframe-holiday-begin-date": "2026-11-02",
        "country-abbreviation": "string",
        "state-province-abbreviation": "string",
        "holiday-api-location-hint": "string",
        "timeframe-holiday-begin-time-1": "string",
        "timeframe-holiday-end-time-1": "string",
        "timeframe-holiday-begin-time-2": "string",
        "timeframe-holiday-end-time-2": "string",
        "timeframe-weekly-monday-observance-option": "string",
        "timeframe-weekly-tuesday-observance-option": "string",
        "timeframe-weekly-wednesday-observance-option": "string",
        "timeframe-weekly-thursday-observance-option": "string",
        "timeframe-weekly-friday-observance-option": "string",
        "timeframe-weekly-saturday-observance-option": "string",
        "timeframe-weekly-sunday-observance-option": "string",
        "timeframe-workweek-list": "string",
        "timeframe-recurrence-type": "string",
        "timeframe-recurrence-end-option": "string",
        "timeframe-recurrence-end-date": "2026-11-02"
      }
    ],
    "timeframe-days-of-week-array": [
      {
        "timeframe-recurrence-begin-date": "2026-11-02",
        "timeframe-recurrence-type": "string",
        "timeframe-recurrence-custom-interval-count": "string",
        "timeframe-recurrence-custom-interval": "string",
        "timeframe-recurrence-custom-interval-option": "string",
        "timeframe-recurrence-end-option": "string",
        "timeframe-recurrence-end-date": "2026-11-02"
      }
    ]
  }),
});
const data = await res.json();

import os, requests

r = requests.post(
    "https://api.noodlevoice.com/ns-api/v2/domains/~/timeframes/{id}",
    headers={"Authorization": "Bearer " + os.environ["NOODLEVOICE_KEY"]},
    json={
        "timeframe-specific-dates-array": [
            {
                "timeframe-specific-dates-begin-date": "2026-11-02",
                "timeframe-specific-dates-begin-time": "string",
                "timeframe-specific-dates-end-date": "2026-11-02",
                "timeframe-specific-dates-end-time": "string",
                "timeframe-recurrence-type": "string",
                "timeframe-recurrence-custom-interval-count": "string",
                "timeframe-recurrence-custom-interval": "string",
                "timeframe-recurrence-custom-interval-option": "string",
                "timeframe-recurrence-end-option": "string",
                "timeframe-recurrence-end-date": "2026-11-02"
            }
        ],
        "timeframe-holiday-array": [
            {
                "timeframe-holiday-uuid": "string",
                "timeframe-holiday-name": "Front Desk",
                "timeframe-holiday-begin-date": "2026-11-02",
                "country-abbreviation": "string",
                "state-province-abbreviation": "string",
                "holiday-api-location-hint": "string",
                "timeframe-holiday-begin-time-1": "string",
                "timeframe-holiday-end-time-1": "string",
                "timeframe-holiday-begin-time-2": "string",
                "timeframe-holiday-end-time-2": "string",
                "timeframe-weekly-monday-observance-option": "string",
                "timeframe-weekly-tuesday-observance-option": "string",
                "timeframe-weekly-wednesday-observance-option": "string",
                "timeframe-weekly-thursday-observance-option": "string",
                "timeframe-weekly-friday-observance-option": "string",
                "timeframe-weekly-saturday-observance-option": "string",
                "timeframe-weekly-sunday-observance-option": "string",
                "timeframe-workweek-list": "string",
                "timeframe-recurrence-type": "string",
                "timeframe-recurrence-end-option": "string",
                "timeframe-recurrence-end-date": "2026-11-02"
            }
        ],
        "timeframe-days-of-week-array": [
            {
                "timeframe-recurrence-begin-date": "2026-11-02",
                "timeframe-recurrence-type": "string",
                "timeframe-recurrence-custom-interval-count": "string",
                "timeframe-recurrence-custom-interval": "string",
                "timeframe-recurrence-custom-interval-option": "string",
                "timeframe-recurrence-end-option": "string",
                "timeframe-recurrence-end-date": "2026-11-02"
            }
        ]
    },
)
print(r.status_code, r.json())

Response 202

Returns a status code with a short JSON message.

Other responses: 400, 401, 404. See errors.

Add date ranges to a time frame

POST/domains/~/timeframes/{id}

Adds more date ranges to a specific dates time frame.

Write Key Admin switch: Schedules (time frames), Write.

Parameters

Name	In	Type	Notes
`id` required	path	string	The ID of the item, as returned when you list or create it.

Request body application/json

Field	Type	Notes
`timeframe-specific-dates-array`	array of object
`timeframe-specific-dates-array[].timeframe-id`	string	The time frame's ID.
`timeframe-specific-dates-array[].timeframe-parent-id`	string	ID of the timeframe parent.
`timeframe-specific-dates-array[].ordinal-order`	number
`timeframe-specific-dates-array[].timeframe-specific-dates-begin-date` required	string	Timeframe specific dates begin (date).
`timeframe-specific-dates-array[].timeframe-specific-dates-begin-time` required	string
`timeframe-specific-dates-array[].timeframe-specific-dates-end-date` required	string	Timeframe specific dates end (date).
`timeframe-specific-dates-array[].timeframe-specific-dates-end-time` required	string
`timeframe-specific-dates-array[].timeframe-recurrence-type` required	string
`timeframe-specific-dates-array[].timeframe-recurrence-custom-interval` required	string
`timeframe-specific-dates-array[].timeframe-recurrence-custom-interval-count` required	string	Number of timeframe recurrence custom interval.
`timeframe-specific-dates-array[].timeframe-recurrence-custom-interval-option` required	string
`timeframe-specific-dates-array[].timeframe-recurrence-end-option` required	string
`timeframe-specific-dates-array[].timeframe-recurrence-end-date` required	string	Timeframe recurrence end (date).
`timeframe-specific-dates-array[].timeframe-expiry-datetime`	string	Timeframe expiry (date and time).
`timeframe-specific-dates-array[].domain`	string	The account the item belongs to.
`timeframe-specific-dates-array[].timeframe-recurrence-rrule`	string
`timeframe-specific-dates-array[].timeframe-next-observance-datetime`	array of number	Timeframe next observance (date and time).
`timeframe-specific-dates-array[].timeframe-is-v1`	boolean
`timeframe-days-of-week-array`	array of object
`timeframe-days-of-week-array[].timeframe-id`	string	The time frame's ID.
`timeframe-days-of-week-array[].timeframe-parent-id`	string	ID of the timeframe parent.
`timeframe-days-of-week-array[].ordinal-order`	number
`timeframe-days-of-week-array[].timeframe-weekly-sunday-begin-time-1`	string
`timeframe-days-of-week-array[].timeframe-weekly-sunday-end-time-1`	string
`timeframe-days-of-week-array[].timeframe-weekly-sunday-begin-time-2`	string
`timeframe-days-of-week-array[].timeframe-weekly-sunday-end-time-2`	string
`timeframe-days-of-week-array[].timeframe-weekly-monday-begin-time-1`	string
`timeframe-days-of-week-array[].timeframe-weekly-monday-end-time-1`	string
`timeframe-days-of-week-array[].timeframe-weekly-monday-begin-time-2`	string
`timeframe-days-of-week-array[].timeframe-weekly-monday-end-time-2`	string
`timeframe-days-of-week-array[].timeframe-weekly-tuesday-begin-time-1`	string
`timeframe-days-of-week-array[].timeframe-weekly-tuesday-end-time-1`	string
`timeframe-days-of-week-array[].timeframe-weekly-tuesday-begin-time-2`	string
`timeframe-days-of-week-array[].timeframe-weekly-tuesday-end-time-2`	string
`timeframe-days-of-week-array[].timeframe-weekly-wednesday-begin-time-1`	string
`timeframe-days-of-week-array[].timeframe-weekly-wednesday-end-time-1`	string
`timeframe-days-of-week-array[].timeframe-weekly-wednesday-begin-time-2`	string
`timeframe-days-of-week-array[].timeframe-weekly-wednesday-end-time-2`	string
`timeframe-days-of-week-array[].timeframe-weekly-thursday-begin-time-1`	string
`timeframe-days-of-week-array[].timeframe-weekly-thursday-end-time-1`	string
`timeframe-days-of-week-array[].timeframe-weekly-thursday-begin-time-2`	string
`timeframe-days-of-week-array[].timeframe-weekly-thursday-end-time-2`	string
`timeframe-days-of-week-array[].timeframe-weekly-friday-begin-time-1`	string
`timeframe-days-of-week-array[].timeframe-weekly-friday-end-time-1`	string
`timeframe-days-of-week-array[].timeframe-weekly-friday-begin-time-2`	string
`timeframe-days-of-week-array[].timeframe-weekly-friday-end-time-2`	string
`timeframe-days-of-week-array[].timeframe-weekly-saturday-begin-time-1`	string
`timeframe-days-of-week-array[].timeframe-weekly-saturday-end-time-1`	string
`timeframe-days-of-week-array[].timeframe-weekly-saturday-begin-time-2`	string
`timeframe-days-of-week-array[].timeframe-weekly-saturday-end-time-2`	string
`timeframe-days-of-week-array[].timeframe-recurrence-type` required	string
`timeframe-days-of-week-array[].timeframe-recurrence-begin-date` required	string	Timeframe recurrence begin (date).
`timeframe-days-of-week-array[].timeframe-recurrence-custom-interval` required	string
`timeframe-days-of-week-array[].timeframe-recurrence-custom-interval-count` required	string	Number of timeframe recurrence custom interval.
`timeframe-days-of-week-array[].timeframe-recurrence-custom-interval-option` required	string
`timeframe-days-of-week-array[].timeframe-recurrence-end-option` required	string
`timeframe-days-of-week-array[].timeframe-recurrence-end-date` required	string	Timeframe recurrence end (date).
`timeframe-days-of-week-array[].timeframe-expiry-datetime`	string	Timeframe expiry (date and time).
`timeframe-days-of-week-array[].domain`	string	The account the item belongs to.
`timeframe-days-of-week-array[].timeframe-next-observance-datetime`	array of number	Timeframe next observance (date and time).
`timeframe-days-of-week-array[].timeframe-recurrence-rrule`	string
`timeframe-days-of-week-array[].timeframe-is-v1`	boolean

Example request

curl -X POST "https://api.noodlevoice.com/ns-api/v2/domains/~/timeframes/{id}" \
  -H "Authorization: Bearer $NOODLEVOICE_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "timeframe-specific-dates-array": [
      {
        "timeframe-specific-dates-begin-date": "2026-11-02",
        "timeframe-specific-dates-begin-time": "string",
        "timeframe-specific-dates-end-date": "2026-11-02",
        "timeframe-specific-dates-end-time": "string",
        "timeframe-recurrence-type": "string",
        "timeframe-recurrence-custom-interval-count": "string",
        "timeframe-recurrence-custom-interval": "string",
        "timeframe-recurrence-custom-interval-option": "string",
        "timeframe-recurrence-end-option": "string",
        "timeframe-recurrence-end-date": "2026-11-02"
      }
    ],
    "timeframe-days-of-week-array": [
      {
        "timeframe-recurrence-begin-date": "2026-11-02",
        "timeframe-recurrence-type": "string",
        "timeframe-recurrence-custom-interval-count": "string",
        "timeframe-recurrence-custom-interval": "string",
        "timeframe-recurrence-custom-interval-option": "string",
        "timeframe-recurrence-end-option": "string",
        "timeframe-recurrence-end-date": "2026-11-02"
      }
    ]
  }'

const res = await fetch("https://api.noodlevoice.com/ns-api/v2/domains/~/timeframes/{id}", {
  method: "POST",
  headers: {
    Authorization: "Bearer " + process.env.NOODLEVOICE_KEY,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "timeframe-specific-dates-array": [
      {
        "timeframe-specific-dates-begin-date": "2026-11-02",
        "timeframe-specific-dates-begin-time": "string",
        "timeframe-specific-dates-end-date": "2026-11-02",
        "timeframe-specific-dates-end-time": "string",
        "timeframe-recurrence-type": "string",
        "timeframe-recurrence-custom-interval-count": "string",
        "timeframe-recurrence-custom-interval": "string",
        "timeframe-recurrence-custom-interval-option": "string",
        "timeframe-recurrence-end-option": "string",
        "timeframe-recurrence-end-date": "2026-11-02"
      }
    ],
    "timeframe-days-of-week-array": [
      {
        "timeframe-recurrence-begin-date": "2026-11-02",
        "timeframe-recurrence-type": "string",
        "timeframe-recurrence-custom-interval-count": "string",
        "timeframe-recurrence-custom-interval": "string",
        "timeframe-recurrence-custom-interval-option": "string",
        "timeframe-recurrence-end-option": "string",
        "timeframe-recurrence-end-date": "2026-11-02"
      }
    ]
  }),
});
const data = await res.json();

import os, requests

r = requests.post(
    "https://api.noodlevoice.com/ns-api/v2/domains/~/timeframes/{id}",
    headers={"Authorization": "Bearer " + os.environ["NOODLEVOICE_KEY"]},
    json={
        "timeframe-specific-dates-array": [
            {
                "timeframe-specific-dates-begin-date": "2026-11-02",
                "timeframe-specific-dates-begin-time": "string",
                "timeframe-specific-dates-end-date": "2026-11-02",
                "timeframe-specific-dates-end-time": "string",
                "timeframe-recurrence-type": "string",
                "timeframe-recurrence-custom-interval-count": "string",
                "timeframe-recurrence-custom-interval": "string",
                "timeframe-recurrence-custom-interval-option": "string",
                "timeframe-recurrence-end-option": "string",
                "timeframe-recurrence-end-date": "2026-11-02"
            }
        ],
        "timeframe-days-of-week-array": [
            {
                "timeframe-recurrence-begin-date": "2026-11-02",
                "timeframe-recurrence-type": "string",
                "timeframe-recurrence-custom-interval-count": "string",
                "timeframe-recurrence-custom-interval": "string",
                "timeframe-recurrence-custom-interval-option": "string",
                "timeframe-recurrence-end-option": "string",
                "timeframe-recurrence-end-date": "2026-11-02"
            }
        ]
    },
)
print(r.status_code, r.json())

Response 202

Returns a status code with a short JSON message.

Update date ranges in a time frame

PUT/domains/~/timeframes/{id}

Changes selected date ranges in a specific dates time frame.

Write Key Admin switch: Schedules (time frames), Write.

Parameters

Name	In	Type	Notes
`id` required	path	string	The ID of the item, as returned when you list or create it.

Request body application/json

Field	Type	Notes
`update_only` required	string	Set to `yes` to change only the entries you send and keep the rest.
`timeframe-specific-dates-array`	array of object
`timeframe-specific-dates-array[].timeframe-id`	string	The time frame's ID.
`timeframe-specific-dates-array[].timeframe-parent-id`	string	ID of the timeframe parent.
`timeframe-specific-dates-array[].ordinal-order`	number
`timeframe-specific-dates-array[].timeframe-specific-dates-begin-date` required	string	Timeframe specific dates begin (date).
`timeframe-specific-dates-array[].timeframe-specific-dates-begin-time` required	string
`timeframe-specific-dates-array[].timeframe-specific-dates-end-date` required	string	Timeframe specific dates end (date).
`timeframe-specific-dates-array[].timeframe-specific-dates-end-time` required	string
`timeframe-specific-dates-array[].timeframe-recurrence-type` required	string
`timeframe-specific-dates-array[].timeframe-recurrence-custom-interval` required	string
`timeframe-specific-dates-array[].timeframe-recurrence-custom-interval-count` required	string	Number of timeframe recurrence custom interval.
`timeframe-specific-dates-array[].timeframe-recurrence-custom-interval-option` required	string
`timeframe-specific-dates-array[].timeframe-recurrence-end-option` required	string
`timeframe-specific-dates-array[].timeframe-recurrence-end-date` required	string	Timeframe recurrence end (date).
`timeframe-specific-dates-array[].timeframe-expiry-datetime`	string	Timeframe expiry (date and time).
`timeframe-specific-dates-array[].domain`	string	The account the item belongs to.
`timeframe-specific-dates-array[].timeframe-recurrence-rrule`	string
`timeframe-specific-dates-array[].timeframe-next-observance-datetime`	array of number	Timeframe next observance (date and time).
`timeframe-specific-dates-array[].timeframe-is-v1`	boolean

Example request

curl -X PUT "https://api.noodlevoice.com/ns-api/v2/domains/~/timeframes/{id}" \
  -H "Authorization: Bearer $NOODLEVOICE_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "update_only": "string"
  }'

const res = await fetch("https://api.noodlevoice.com/ns-api/v2/domains/~/timeframes/{id}", {
  method: "PUT",
  headers: {
    Authorization: "Bearer " + process.env.NOODLEVOICE_KEY,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "update_only": "string"
  }),
});
const data = await res.json();

import os, requests

r = requests.put(
    "https://api.noodlevoice.com/ns-api/v2/domains/~/timeframes/{id}",
    headers={"Authorization": "Bearer " + os.environ["NOODLEVOICE_KEY"]},
    json={
        "update_only": "string"
    },
)
print(r.status_code, r.json())

Response 200

Returns a status code with a short JSON message.

Other responses: 400, 401, 404. See errors.

Update weekly hours in a time frame

PUT/domains/~/timeframes/{id}

Changes the weekly hours of a days of week time frame.

Write Key Admin switch: Schedules (time frames), Write.

Parameters

Name	In	Type	Notes
`id` required	path	string	The ID of the item, as returned when you list or create it.

Request body application/json

Field	Type	Notes
`update-only` required	string	Set to `yes` to change only the entries you send and keep the rest.
`timeframe-days-of-week-array`	array of object
`timeframe-days-of-week-array[].timeframe-id`	string	The time frame's ID.
`timeframe-days-of-week-array[].timeframe-parent-id`	string	ID of the timeframe parent.
`timeframe-days-of-week-array[].ordinal-order`	number
`timeframe-days-of-week-array[].timeframe-weekly-sunday-begin-time-1`	string
`timeframe-days-of-week-array[].timeframe-weekly-sunday-end-time-1`	string
`timeframe-days-of-week-array[].timeframe-weekly-sunday-begin-time-2`	string
`timeframe-days-of-week-array[].timeframe-weekly-sunday-end-time-2`	string
`timeframe-days-of-week-array[].timeframe-weekly-monday-begin-time-1`	string
`timeframe-days-of-week-array[].timeframe-weekly-monday-end-time-1`	string
`timeframe-days-of-week-array[].timeframe-weekly-monday-begin-time-2`	string
`timeframe-days-of-week-array[].timeframe-weekly-monday-end-time-2`	string
`timeframe-days-of-week-array[].timeframe-weekly-tuesday-begin-time-1`	string
`timeframe-days-of-week-array[].timeframe-weekly-tuesday-end-time-1`	string
`timeframe-days-of-week-array[].timeframe-weekly-tuesday-begin-time-2`	string
`timeframe-days-of-week-array[].timeframe-weekly-tuesday-end-time-2`	string
`timeframe-days-of-week-array[].timeframe-weekly-wednesday-begin-time-1`	string
`timeframe-days-of-week-array[].timeframe-weekly-wednesday-end-time-1`	string
`timeframe-days-of-week-array[].timeframe-weekly-wednesday-begin-time-2`	string
`timeframe-days-of-week-array[].timeframe-weekly-wednesday-end-time-2`	string
`timeframe-days-of-week-array[].timeframe-weekly-thursday-begin-time-1`	string
`timeframe-days-of-week-array[].timeframe-weekly-thursday-end-time-1`	string
`timeframe-days-of-week-array[].timeframe-weekly-thursday-begin-time-2`	string
`timeframe-days-of-week-array[].timeframe-weekly-thursday-end-time-2`	string
`timeframe-days-of-week-array[].timeframe-weekly-friday-begin-time-1`	string
`timeframe-days-of-week-array[].timeframe-weekly-friday-end-time-1`	string
`timeframe-days-of-week-array[].timeframe-weekly-friday-begin-time-2`	string
`timeframe-days-of-week-array[].timeframe-weekly-friday-end-time-2`	string
`timeframe-days-of-week-array[].timeframe-weekly-saturday-begin-time-1`	string
`timeframe-days-of-week-array[].timeframe-weekly-saturday-end-time-1`	string
`timeframe-days-of-week-array[].timeframe-weekly-saturday-begin-time-2`	string
`timeframe-days-of-week-array[].timeframe-weekly-saturday-end-time-2`	string
`timeframe-days-of-week-array[].timeframe-recurrence-type` required	string
`timeframe-days-of-week-array[].timeframe-recurrence-begin-date` required	string	Timeframe recurrence begin (date).
`timeframe-days-of-week-array[].timeframe-recurrence-custom-interval` required	string
`timeframe-days-of-week-array[].timeframe-recurrence-custom-interval-count` required	string	Number of timeframe recurrence custom interval.
`timeframe-days-of-week-array[].timeframe-recurrence-custom-interval-option` required	string
`timeframe-days-of-week-array[].timeframe-recurrence-end-option` required	string
`timeframe-days-of-week-array[].timeframe-recurrence-end-date` required	string	Timeframe recurrence end (date).
`timeframe-days-of-week-array[].timeframe-expiry-datetime`	string	Timeframe expiry (date and time).
`timeframe-days-of-week-array[].domain`	string	The account the item belongs to.
`timeframe-days-of-week-array[].timeframe-next-observance-datetime`	array of number	Timeframe next observance (date and time).
`timeframe-days-of-week-array[].timeframe-recurrence-rrule`	string
`timeframe-days-of-week-array[].timeframe-is-v1`	boolean

Example request

curl -X PUT "https://api.noodlevoice.com/ns-api/v2/domains/~/timeframes/{id}" \
  -H "Authorization: Bearer $NOODLEVOICE_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "update-only": "string"
  }'

const res = await fetch("https://api.noodlevoice.com/ns-api/v2/domains/~/timeframes/{id}", {
  method: "PUT",
  headers: {
    Authorization: "Bearer " + process.env.NOODLEVOICE_KEY,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "update-only": "string"
  }),
});
const data = await res.json();

import os, requests

r = requests.put(
    "https://api.noodlevoice.com/ns-api/v2/domains/~/timeframes/{id}",
    headers={"Authorization": "Bearer " + os.environ["NOODLEVOICE_KEY"]},
    json={
        "update-only": "string"
    },
)
print(r.status_code, r.json())

Response 200

Returns a status code with a short JSON message.

Replace a time frame's holidays

PUT/domains/~/timeframes/{id}

Replaces every holiday in a holidays time frame with the ones you send.

Write Key Admin switch: Schedules (time frames), Write.

Parameters

Name	In	Type	Notes
`id` required	path	string	The ID of the item, as returned when you list or create it.

Request body application/json

Field	Type	Notes
`timeframe-holiday-array`	array of object
`timeframe-holiday-array[].timeframe-id`	string	The time frame's ID.
`timeframe-holiday-array[].timeframe-parent-id`	string	ID of the timeframe parent.
`timeframe-holiday-array[].ordinal-order`	number
`timeframe-holiday-array[].timeframe-holiday-uuid` required	string
`timeframe-holiday-array[].timeframe-holiday-name` required	string	Name of the timeframe holiday.
`timeframe-holiday-array[].timeframe-holiday-begin-date` required	string	Timeframe holiday begin (date).
`timeframe-holiday-array[].country-abbreviation` required	string
`timeframe-holiday-array[].state-province-abbreviation` required	string
`timeframe-holiday-array[].holiday-api-location-hint` required	string
`timeframe-holiday-array[].timeframe-holiday-begin-time-1` required	string
`timeframe-holiday-array[].timeframe-holiday-end-time-1` required	string
`timeframe-holiday-array[].timeframe-holiday-begin-time-2` required	string
`timeframe-holiday-array[].timeframe-holiday-end-time-2` required	string
`timeframe-holiday-array[].timeframe-weekly-monday-observance-option` required	string
`timeframe-holiday-array[].timeframe-weekly-tuesday-observance-option` required	string
`timeframe-holiday-array[].timeframe-weekly-wednesday-observance-option` required	string
`timeframe-holiday-array[].timeframe-weekly-thursday-observance-option` required	string
`timeframe-holiday-array[].timeframe-weekly-friday-observance-option` required	string
`timeframe-holiday-array[].timeframe-weekly-saturday-observance-option` required	string
`timeframe-holiday-array[].timeframe-weekly-sunday-observance-option` required	string
`timeframe-holiday-array[].timeframe-workweek-list` required	string
`timeframe-holiday-array[].timeframe-recurrence-type` required	string
`timeframe-holiday-array[].timeframe-recurrence-end-option` required	string
`timeframe-holiday-array[].timeframe-recurrence-end-date` required	string	Timeframe recurrence end (date).
`timeframe-holiday-array[].timeframe-expiry-datetime`	string	Timeframe expiry (date and time).
`timeframe-holiday-array[].domain`	string	The account the item belongs to.
`timeframe-holiday-array[].timeframe-next-observance-datetime`	array of number	Timeframe next observance (date and time).

Example request

curl -X PUT "https://api.noodlevoice.com/ns-api/v2/domains/~/timeframes/{id}" \
  -H "Authorization: Bearer $NOODLEVOICE_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "timeframe-holiday-array": [
      {
        "timeframe-holiday-uuid": "string",
        "timeframe-holiday-name": "Front Desk",
        "timeframe-holiday-begin-date": "2026-11-02",
        "country-abbreviation": "string",
        "state-province-abbreviation": "string",
        "holiday-api-location-hint": "string",
        "timeframe-holiday-begin-time-1": "string",
        "timeframe-holiday-end-time-1": "string",
        "timeframe-holiday-begin-time-2": "string",
        "timeframe-holiday-end-time-2": "string",
        "timeframe-weekly-monday-observance-option": "string",
        "timeframe-weekly-tuesday-observance-option": "string",
        "timeframe-weekly-wednesday-observance-option": "string",
        "timeframe-weekly-thursday-observance-option": "string",
        "timeframe-weekly-friday-observance-option": "string",
        "timeframe-weekly-saturday-observance-option": "string",
        "timeframe-weekly-sunday-observance-option": "string",
        "timeframe-workweek-list": "string",
        "timeframe-recurrence-type": "string",
        "timeframe-recurrence-end-option": "string",
        "timeframe-recurrence-end-date": "2026-11-02"
      }
    ]
  }'

const res = await fetch("https://api.noodlevoice.com/ns-api/v2/domains/~/timeframes/{id}", {
  method: "PUT",
  headers: {
    Authorization: "Bearer " + process.env.NOODLEVOICE_KEY,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "timeframe-holiday-array": [
      {
        "timeframe-holiday-uuid": "string",
        "timeframe-holiday-name": "Front Desk",
        "timeframe-holiday-begin-date": "2026-11-02",
        "country-abbreviation": "string",
        "state-province-abbreviation": "string",
        "holiday-api-location-hint": "string",
        "timeframe-holiday-begin-time-1": "string",
        "timeframe-holiday-end-time-1": "string",
        "timeframe-holiday-begin-time-2": "string",
        "timeframe-holiday-end-time-2": "string",
        "timeframe-weekly-monday-observance-option": "string",
        "timeframe-weekly-tuesday-observance-option": "string",
        "timeframe-weekly-wednesday-observance-option": "string",
        "timeframe-weekly-thursday-observance-option": "string",
        "timeframe-weekly-friday-observance-option": "string",
        "timeframe-weekly-saturday-observance-option": "string",
        "timeframe-weekly-sunday-observance-option": "string",
        "timeframe-workweek-list": "string",
        "timeframe-recurrence-type": "string",
        "timeframe-recurrence-end-option": "string",
        "timeframe-recurrence-end-date": "2026-11-02"
      }
    ]
  }),
});
const data = await res.json();

import os, requests

r = requests.put(
    "https://api.noodlevoice.com/ns-api/v2/domains/~/timeframes/{id}",
    headers={"Authorization": "Bearer " + os.environ["NOODLEVOICE_KEY"]},
    json={
        "timeframe-holiday-array": [
            {
                "timeframe-holiday-uuid": "string",
                "timeframe-holiday-name": "Front Desk",
                "timeframe-holiday-begin-date": "2026-11-02",
                "country-abbreviation": "string",
                "state-province-abbreviation": "string",
                "holiday-api-location-hint": "string",
                "timeframe-holiday-begin-time-1": "string",
                "timeframe-holiday-end-time-1": "string",
                "timeframe-holiday-begin-time-2": "string",
                "timeframe-holiday-end-time-2": "string",
                "timeframe-weekly-monday-observance-option": "string",
                "timeframe-weekly-tuesday-observance-option": "string",
                "timeframe-weekly-wednesday-observance-option": "string",
                "timeframe-weekly-thursday-observance-option": "string",
                "timeframe-weekly-friday-observance-option": "string",
                "timeframe-weekly-saturday-observance-option": "string",
                "timeframe-weekly-sunday-observance-option": "string",
                "timeframe-workweek-list": "string",
                "timeframe-recurrence-type": "string",
                "timeframe-recurrence-end-option": "string",
                "timeframe-recurrence-end-date": "2026-11-02"
            }
        ]
    },
)
print(r.status_code, r.json())

Response 200

Returns a status code with a short JSON message.

Update holidays in a time frame

PUT/domains/~/timeframes/{id}

Changes selected holidays in a holidays time frame.

Write Key Admin switch: Schedules (time frames), Write.

Parameters

Name	In	Type	Notes
`id` required	path	string	The ID of the item, as returned when you list or create it.

Request body application/json

Field	Type	Notes
`update-only` required	string	Set to `yes` to change only the entries you send and keep the rest.
`timeframe-holiday-array`	array of object
`timeframe-holiday-array[].timeframe-id`	string	The time frame's ID.
`timeframe-holiday-array[].timeframe-parent-id`	string	ID of the timeframe parent.
`timeframe-holiday-array[].ordinal-order`	number
`timeframe-holiday-array[].timeframe-holiday-uuid` required	string
`timeframe-holiday-array[].timeframe-holiday-name` required	string	Name of the timeframe holiday.
`timeframe-holiday-array[].timeframe-holiday-begin-date` required	string	Timeframe holiday begin (date).
`timeframe-holiday-array[].country-abbreviation` required	string
`timeframe-holiday-array[].state-province-abbreviation` required	string
`timeframe-holiday-array[].holiday-api-location-hint` required	string
`timeframe-holiday-array[].timeframe-holiday-begin-time-1` required	string
`timeframe-holiday-array[].timeframe-holiday-end-time-1` required	string
`timeframe-holiday-array[].timeframe-holiday-begin-time-2` required	string
`timeframe-holiday-array[].timeframe-holiday-end-time-2` required	string
`timeframe-holiday-array[].timeframe-weekly-monday-observance-option` required	string
`timeframe-holiday-array[].timeframe-weekly-tuesday-observance-option` required	string
`timeframe-holiday-array[].timeframe-weekly-wednesday-observance-option` required	string
`timeframe-holiday-array[].timeframe-weekly-thursday-observance-option` required	string
`timeframe-holiday-array[].timeframe-weekly-friday-observance-option` required	string
`timeframe-holiday-array[].timeframe-weekly-saturday-observance-option` required	string
`timeframe-holiday-array[].timeframe-weekly-sunday-observance-option` required	string
`timeframe-holiday-array[].timeframe-workweek-list` required	string
`timeframe-holiday-array[].timeframe-recurrence-type` required	string
`timeframe-holiday-array[].timeframe-recurrence-end-option` required	string
`timeframe-holiday-array[].timeframe-recurrence-end-date` required	string	Timeframe recurrence end (date).
`timeframe-holiday-array[].timeframe-expiry-datetime`	string	Timeframe expiry (date and time).
`timeframe-holiday-array[].domain`	string	The account the item belongs to.
`timeframe-holiday-array[].timeframe-next-observance-datetime`	array of number	Timeframe next observance (date and time).

Example request

curl -X PUT "https://api.noodlevoice.com/ns-api/v2/domains/~/timeframes/{id}" \
  -H "Authorization: Bearer $NOODLEVOICE_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "update-only": "string"
  }'

const res = await fetch("https://api.noodlevoice.com/ns-api/v2/domains/~/timeframes/{id}", {
  method: "PUT",
  headers: {
    Authorization: "Bearer " + process.env.NOODLEVOICE_KEY,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "update-only": "string"
  }),
});
const data = await res.json();

import os, requests

r = requests.put(
    "https://api.noodlevoice.com/ns-api/v2/domains/~/timeframes/{id}",
    headers={"Authorization": "Bearer " + os.environ["NOODLEVOICE_KEY"]},
    json={
        "update-only": "string"
    },
)
print(r.status_code, r.json())

Response 200

Returns a status code with a short JSON message.

Replace a custom time frame's entries

PUT/domains/~/timeframes/{id}

Replaces every entry in a custom time frame with the ones you send.

Write Key Admin switch: Schedules (time frames), Write.

Parameters

Name	In	Type	Notes
`id` required	path	string	The ID of the item, as returned when you list or create it.

Request body application/json

Field	Type	Notes
`timeframe-specific-dates-array`	array of object
`timeframe-specific-dates-array[].timeframe-id`	string	The time frame's ID.
`timeframe-specific-dates-array[].timeframe-parent-id`	string	ID of the timeframe parent.
`timeframe-specific-dates-array[].ordinal-order`	number
`timeframe-specific-dates-array[].timeframe-specific-dates-begin-date` required	string	Timeframe specific dates begin (date).
`timeframe-specific-dates-array[].timeframe-specific-dates-begin-time` required	string
`timeframe-specific-dates-array[].timeframe-specific-dates-end-date` required	string	Timeframe specific dates end (date).
`timeframe-specific-dates-array[].timeframe-specific-dates-end-time` required	string
`timeframe-specific-dates-array[].timeframe-recurrence-type` required	string
`timeframe-specific-dates-array[].timeframe-recurrence-custom-interval` required	string
`timeframe-specific-dates-array[].timeframe-recurrence-custom-interval-count` required	string	Number of timeframe recurrence custom interval.
`timeframe-specific-dates-array[].timeframe-recurrence-custom-interval-option` required	string
`timeframe-specific-dates-array[].timeframe-recurrence-end-option` required	string
`timeframe-specific-dates-array[].timeframe-recurrence-end-date` required	string	Timeframe recurrence end (date).
`timeframe-specific-dates-array[].timeframe-expiry-datetime`	string	Timeframe expiry (date and time).
`timeframe-specific-dates-array[].domain`	string	The account the item belongs to.
`timeframe-specific-dates-array[].timeframe-recurrence-rrule`	string
`timeframe-specific-dates-array[].timeframe-next-observance-datetime`	array of number	Timeframe next observance (date and time).
`timeframe-specific-dates-array[].timeframe-is-v1`	boolean
`timeframe-holiday-array`	array of object
`timeframe-holiday-array[].timeframe-id`	string	The time frame's ID.
`timeframe-holiday-array[].timeframe-parent-id`	string	ID of the timeframe parent.
`timeframe-holiday-array[].ordinal-order`	number
`timeframe-holiday-array[].timeframe-holiday-uuid` required	string
`timeframe-holiday-array[].timeframe-holiday-name` required	string	Name of the timeframe holiday.
`timeframe-holiday-array[].timeframe-holiday-begin-date` required	string	Timeframe holiday begin (date).
`timeframe-holiday-array[].country-abbreviation` required	string
`timeframe-holiday-array[].state-province-abbreviation` required	string
`timeframe-holiday-array[].holiday-api-location-hint` required	string
`timeframe-holiday-array[].timeframe-holiday-begin-time-1` required	string
`timeframe-holiday-array[].timeframe-holiday-end-time-1` required	string
`timeframe-holiday-array[].timeframe-holiday-begin-time-2` required	string
`timeframe-holiday-array[].timeframe-holiday-end-time-2` required	string
`timeframe-holiday-array[].timeframe-weekly-monday-observance-option` required	string
`timeframe-holiday-array[].timeframe-weekly-tuesday-observance-option` required	string
`timeframe-holiday-array[].timeframe-weekly-wednesday-observance-option` required	string
`timeframe-holiday-array[].timeframe-weekly-thursday-observance-option` required	string
`timeframe-holiday-array[].timeframe-weekly-friday-observance-option` required	string
`timeframe-holiday-array[].timeframe-weekly-saturday-observance-option` required	string
`timeframe-holiday-array[].timeframe-weekly-sunday-observance-option` required	string
`timeframe-holiday-array[].timeframe-workweek-list` required	string
`timeframe-holiday-array[].timeframe-recurrence-type` required	string
`timeframe-holiday-array[].timeframe-recurrence-end-option` required	string
`timeframe-holiday-array[].timeframe-recurrence-end-date` required	string	Timeframe recurrence end (date).
`timeframe-holiday-array[].timeframe-expiry-datetime`	string	Timeframe expiry (date and time).
`timeframe-holiday-array[].domain`	string	The account the item belongs to.
`timeframe-holiday-array[].timeframe-next-observance-datetime`	array of number	Timeframe next observance (date and time).
`timeframe-days-of-week-array`	array of object
`timeframe-days-of-week-array[].timeframe-id`	string	The time frame's ID.
`timeframe-days-of-week-array[].timeframe-parent-id`	string	ID of the timeframe parent.
`timeframe-days-of-week-array[].ordinal-order`	number
`timeframe-days-of-week-array[].timeframe-weekly-sunday-begin-time-1`	string
`timeframe-days-of-week-array[].timeframe-weekly-sunday-end-time-1`	string
`timeframe-days-of-week-array[].timeframe-weekly-sunday-begin-time-2`	string
`timeframe-days-of-week-array[].timeframe-weekly-sunday-end-time-2`	string
`timeframe-days-of-week-array[].timeframe-weekly-monday-begin-time-1`	string
`timeframe-days-of-week-array[].timeframe-weekly-monday-end-time-1`	string
`timeframe-days-of-week-array[].timeframe-weekly-monday-begin-time-2`	string
`timeframe-days-of-week-array[].timeframe-weekly-monday-end-time-2`	string
`timeframe-days-of-week-array[].timeframe-weekly-tuesday-begin-time-1`	string
`timeframe-days-of-week-array[].timeframe-weekly-tuesday-end-time-1`	string
`timeframe-days-of-week-array[].timeframe-weekly-tuesday-begin-time-2`	string
`timeframe-days-of-week-array[].timeframe-weekly-tuesday-end-time-2`	string
`timeframe-days-of-week-array[].timeframe-weekly-wednesday-begin-time-1`	string
`timeframe-days-of-week-array[].timeframe-weekly-wednesday-end-time-1`	string
`timeframe-days-of-week-array[].timeframe-weekly-wednesday-begin-time-2`	string
`timeframe-days-of-week-array[].timeframe-weekly-wednesday-end-time-2`	string
`timeframe-days-of-week-array[].timeframe-weekly-thursday-begin-time-1`	string
`timeframe-days-of-week-array[].timeframe-weekly-thursday-end-time-1`	string
`timeframe-days-of-week-array[].timeframe-weekly-thursday-begin-time-2`	string
`timeframe-days-of-week-array[].timeframe-weekly-thursday-end-time-2`	string
`timeframe-days-of-week-array[].timeframe-weekly-friday-begin-time-1`	string
`timeframe-days-of-week-array[].timeframe-weekly-friday-end-time-1`	string
`timeframe-days-of-week-array[].timeframe-weekly-friday-begin-time-2`	string
`timeframe-days-of-week-array[].timeframe-weekly-friday-end-time-2`	string
`timeframe-days-of-week-array[].timeframe-weekly-saturday-begin-time-1`	string
`timeframe-days-of-week-array[].timeframe-weekly-saturday-end-time-1`	string
`timeframe-days-of-week-array[].timeframe-weekly-saturday-begin-time-2`	string
`timeframe-days-of-week-array[].timeframe-weekly-saturday-end-time-2`	string
`timeframe-days-of-week-array[].timeframe-recurrence-type` required	string
`timeframe-days-of-week-array[].timeframe-recurrence-begin-date` required	string	Timeframe recurrence begin (date).
`timeframe-days-of-week-array[].timeframe-recurrence-custom-interval` required	string
`timeframe-days-of-week-array[].timeframe-recurrence-custom-interval-count` required	string	Number of timeframe recurrence custom interval.
`timeframe-days-of-week-array[].timeframe-recurrence-custom-interval-option` required	string
`timeframe-days-of-week-array[].timeframe-recurrence-end-option` required	string
`timeframe-days-of-week-array[].timeframe-recurrence-end-date` required	string	Timeframe recurrence end (date).
`timeframe-days-of-week-array[].timeframe-expiry-datetime`	string	Timeframe expiry (date and time).
`timeframe-days-of-week-array[].domain`	string	The account the item belongs to.
`timeframe-days-of-week-array[].timeframe-next-observance-datetime`	array of number	Timeframe next observance (date and time).
`timeframe-days-of-week-array[].timeframe-recurrence-rrule`	string
`timeframe-days-of-week-array[].timeframe-is-v1`	boolean

Example request

curl -X PUT "https://api.noodlevoice.com/ns-api/v2/domains/~/timeframes/{id}" \
  -H "Authorization: Bearer $NOODLEVOICE_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "timeframe-specific-dates-array": [
      {
        "timeframe-specific-dates-begin-date": "2026-11-02",
        "timeframe-specific-dates-begin-time": "string",
        "timeframe-specific-dates-end-date": "2026-11-02",
        "timeframe-specific-dates-end-time": "string",
        "timeframe-recurrence-type": "string",
        "timeframe-recurrence-custom-interval-count": "string",
        "timeframe-recurrence-custom-interval": "string",
        "timeframe-recurrence-custom-interval-option": "string",
        "timeframe-recurrence-end-option": "string",
        "timeframe-recurrence-end-date": "2026-11-02"
      }
    ],
    "timeframe-holiday-array": [
      {
        "timeframe-holiday-uuid": "string",
        "timeframe-holiday-name": "Front Desk",
        "timeframe-holiday-begin-date": "2026-11-02",
        "country-abbreviation": "string",
        "state-province-abbreviation": "string",
        "holiday-api-location-hint": "string",
        "timeframe-holiday-begin-time-1": "string",
        "timeframe-holiday-end-time-1": "string",
        "timeframe-holiday-begin-time-2": "string",
        "timeframe-holiday-end-time-2": "string",
        "timeframe-weekly-monday-observance-option": "string",
        "timeframe-weekly-tuesday-observance-option": "string",
        "timeframe-weekly-wednesday-observance-option": "string",
        "timeframe-weekly-thursday-observance-option": "string",
        "timeframe-weekly-friday-observance-option": "string",
        "timeframe-weekly-saturday-observance-option": "string",
        "timeframe-weekly-sunday-observance-option": "string",
        "timeframe-workweek-list": "string",
        "timeframe-recurrence-type": "string",
        "timeframe-recurrence-end-option": "string",
        "timeframe-recurrence-end-date": "2026-11-02"
      }
    ],
    "timeframe-days-of-week-array": [
      {
        "timeframe-recurrence-begin-date": "2026-11-02",
        "timeframe-recurrence-type": "string",
        "timeframe-recurrence-custom-interval-count": "string",
        "timeframe-recurrence-custom-interval": "string",
        "timeframe-recurrence-custom-interval-option": "string",
        "timeframe-recurrence-end-option": "string",
        "timeframe-recurrence-end-date": "2026-11-02"
      }
    ]
  }'

const res = await fetch("https://api.noodlevoice.com/ns-api/v2/domains/~/timeframes/{id}", {
  method: "PUT",
  headers: {
    Authorization: "Bearer " + process.env.NOODLEVOICE_KEY,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "timeframe-specific-dates-array": [
      {
        "timeframe-specific-dates-begin-date": "2026-11-02",
        "timeframe-specific-dates-begin-time": "string",
        "timeframe-specific-dates-end-date": "2026-11-02",
        "timeframe-specific-dates-end-time": "string",
        "timeframe-recurrence-type": "string",
        "timeframe-recurrence-custom-interval-count": "string",
        "timeframe-recurrence-custom-interval": "string",
        "timeframe-recurrence-custom-interval-option": "string",
        "timeframe-recurrence-end-option": "string",
        "timeframe-recurrence-end-date": "2026-11-02"
      }
    ],
    "timeframe-holiday-array": [
      {
        "timeframe-holiday-uuid": "string",
        "timeframe-holiday-name": "Front Desk",
        "timeframe-holiday-begin-date": "2026-11-02",
        "country-abbreviation": "string",
        "state-province-abbreviation": "string",
        "holiday-api-location-hint": "string",
        "timeframe-holiday-begin-time-1": "string",
        "timeframe-holiday-end-time-1": "string",
        "timeframe-holiday-begin-time-2": "string",
        "timeframe-holiday-end-time-2": "string",
        "timeframe-weekly-monday-observance-option": "string",
        "timeframe-weekly-tuesday-observance-option": "string",
        "timeframe-weekly-wednesday-observance-option": "string",
        "timeframe-weekly-thursday-observance-option": "string",
        "timeframe-weekly-friday-observance-option": "string",
        "timeframe-weekly-saturday-observance-option": "string",
        "timeframe-weekly-sunday-observance-option": "string",
        "timeframe-workweek-list": "string",
        "timeframe-recurrence-type": "string",
        "timeframe-recurrence-end-option": "string",
        "timeframe-recurrence-end-date": "2026-11-02"
      }
    ],
    "timeframe-days-of-week-array": [
      {
        "timeframe-recurrence-begin-date": "2026-11-02",
        "timeframe-recurrence-type": "string",
        "timeframe-recurrence-custom-interval-count": "string",
        "timeframe-recurrence-custom-interval": "string",
        "timeframe-recurrence-custom-interval-option": "string",
        "timeframe-recurrence-end-option": "string",
        "timeframe-recurrence-end-date": "2026-11-02"
      }
    ]
  }),
});
const data = await res.json();

import os, requests

r = requests.put(
    "https://api.noodlevoice.com/ns-api/v2/domains/~/timeframes/{id}",
    headers={"Authorization": "Bearer " + os.environ["NOODLEVOICE_KEY"]},
    json={
        "timeframe-specific-dates-array": [
            {
                "timeframe-specific-dates-begin-date": "2026-11-02",
                "timeframe-specific-dates-begin-time": "string",
                "timeframe-specific-dates-end-date": "2026-11-02",
                "timeframe-specific-dates-end-time": "string",
                "timeframe-recurrence-type": "string",
                "timeframe-recurrence-custom-interval-count": "string",
                "timeframe-recurrence-custom-interval": "string",
                "timeframe-recurrence-custom-interval-option": "string",
                "timeframe-recurrence-end-option": "string",
                "timeframe-recurrence-end-date": "2026-11-02"
            }
        ],
        "timeframe-holiday-array": [
            {
                "timeframe-holiday-uuid": "string",
                "timeframe-holiday-name": "Front Desk",
                "timeframe-holiday-begin-date": "2026-11-02",
                "country-abbreviation": "string",
                "state-province-abbreviation": "string",
                "holiday-api-location-hint": "string",
                "timeframe-holiday-begin-time-1": "string",
                "timeframe-holiday-end-time-1": "string",
                "timeframe-holiday-begin-time-2": "string",
                "timeframe-holiday-end-time-2": "string",
                "timeframe-weekly-monday-observance-option": "string",
                "timeframe-weekly-tuesday-observance-option": "string",
                "timeframe-weekly-wednesday-observance-option": "string",
                "timeframe-weekly-thursday-observance-option": "string",
                "timeframe-weekly-friday-observance-option": "string",
                "timeframe-weekly-saturday-observance-option": "string",
                "timeframe-weekly-sunday-observance-option": "string",
                "timeframe-workweek-list": "string",
                "timeframe-recurrence-type": "string",
                "timeframe-recurrence-end-option": "string",
                "timeframe-recurrence-end-date": "2026-11-02"
            }
        ],
        "timeframe-days-of-week-array": [
            {
                "timeframe-recurrence-begin-date": "2026-11-02",
                "timeframe-recurrence-type": "string",
                "timeframe-recurrence-custom-interval-count": "string",
                "timeframe-recurrence-custom-interval": "string",
                "timeframe-recurrence-custom-interval-option": "string",
                "timeframe-recurrence-end-option": "string",
                "timeframe-recurrence-end-date": "2026-11-02"
            }
        ]
    },
)
print(r.status_code, r.json())

Response 200

Returns a status code with a short JSON message.

Update entries in a custom time frame

PUT/domains/~/timeframes/{id}

Changes selected entries in a custom time frame.

Write Key Admin switch: Schedules (time frames), Write.

Parameters

Name	In	Type	Notes
`id` required	path	string	The ID of the item, as returned when you list or create it.

Request body application/json

Field	Type	Notes
`update-only` required	string	Set to `yes` to change only the entries you send and keep the rest.
`timeframe-specific-dates-array`	array of object
`timeframe-specific-dates-array[].timeframe-id`	string	The time frame's ID.
`timeframe-specific-dates-array[].timeframe-parent-id`	string	ID of the timeframe parent.
`timeframe-specific-dates-array[].ordinal-order`	number
`timeframe-specific-dates-array[].timeframe-specific-dates-begin-date` required	string	Timeframe specific dates begin (date).
`timeframe-specific-dates-array[].timeframe-specific-dates-begin-time` required	string
`timeframe-specific-dates-array[].timeframe-specific-dates-end-date` required	string	Timeframe specific dates end (date).
`timeframe-specific-dates-array[].timeframe-specific-dates-end-time` required	string
`timeframe-specific-dates-array[].timeframe-recurrence-type` required	string
`timeframe-specific-dates-array[].timeframe-recurrence-custom-interval` required	string
`timeframe-specific-dates-array[].timeframe-recurrence-custom-interval-count` required	string	Number of timeframe recurrence custom interval.
`timeframe-specific-dates-array[].timeframe-recurrence-custom-interval-option` required	string
`timeframe-specific-dates-array[].timeframe-recurrence-end-option` required	string
`timeframe-specific-dates-array[].timeframe-recurrence-end-date` required	string	Timeframe recurrence end (date).
`timeframe-specific-dates-array[].timeframe-expiry-datetime`	string	Timeframe expiry (date and time).
`timeframe-specific-dates-array[].domain`	string	The account the item belongs to.
`timeframe-specific-dates-array[].timeframe-recurrence-rrule`	string
`timeframe-specific-dates-array[].timeframe-next-observance-datetime`	array of number	Timeframe next observance (date and time).
`timeframe-specific-dates-array[].timeframe-is-v1`	boolean
`timeframe-holiday-array`	array of object
`timeframe-holiday-array[].timeframe-id`	string	The time frame's ID.
`timeframe-holiday-array[].timeframe-parent-id`	string	ID of the timeframe parent.
`timeframe-holiday-array[].ordinal-order`	number
`timeframe-holiday-array[].timeframe-holiday-uuid` required	string
`timeframe-holiday-array[].timeframe-holiday-name` required	string	Name of the timeframe holiday.
`timeframe-holiday-array[].timeframe-holiday-begin-date` required	string	Timeframe holiday begin (date).
`timeframe-holiday-array[].country-abbreviation` required	string
`timeframe-holiday-array[].state-province-abbreviation` required	string
`timeframe-holiday-array[].holiday-api-location-hint` required	string
`timeframe-holiday-array[].timeframe-holiday-begin-time-1` required	string
`timeframe-holiday-array[].timeframe-holiday-end-time-1` required	string
`timeframe-holiday-array[].timeframe-holiday-begin-time-2` required	string
`timeframe-holiday-array[].timeframe-holiday-end-time-2` required	string
`timeframe-holiday-array[].timeframe-weekly-monday-observance-option` required	string
`timeframe-holiday-array[].timeframe-weekly-tuesday-observance-option` required	string
`timeframe-holiday-array[].timeframe-weekly-wednesday-observance-option` required	string
`timeframe-holiday-array[].timeframe-weekly-thursday-observance-option` required	string
`timeframe-holiday-array[].timeframe-weekly-friday-observance-option` required	string
`timeframe-holiday-array[].timeframe-weekly-saturday-observance-option` required	string
`timeframe-holiday-array[].timeframe-weekly-sunday-observance-option` required	string
`timeframe-holiday-array[].timeframe-workweek-list` required	string
`timeframe-holiday-array[].timeframe-recurrence-type` required	string
`timeframe-holiday-array[].timeframe-recurrence-end-option` required	string
`timeframe-holiday-array[].timeframe-recurrence-end-date` required	string	Timeframe recurrence end (date).
`timeframe-holiday-array[].timeframe-expiry-datetime`	string	Timeframe expiry (date and time).
`timeframe-holiday-array[].domain`	string	The account the item belongs to.
`timeframe-holiday-array[].timeframe-next-observance-datetime`	array of number	Timeframe next observance (date and time).
`timeframe-days-of-week-array`	array of object
`timeframe-days-of-week-array[].timeframe-id`	string	The time frame's ID.
`timeframe-days-of-week-array[].timeframe-parent-id`	string	ID of the timeframe parent.
`timeframe-days-of-week-array[].ordinal-order`	number
`timeframe-days-of-week-array[].timeframe-weekly-sunday-begin-time-1`	string
`timeframe-days-of-week-array[].timeframe-weekly-sunday-end-time-1`	string
`timeframe-days-of-week-array[].timeframe-weekly-sunday-begin-time-2`	string
`timeframe-days-of-week-array[].timeframe-weekly-sunday-end-time-2`	string
`timeframe-days-of-week-array[].timeframe-weekly-monday-begin-time-1`	string
`timeframe-days-of-week-array[].timeframe-weekly-monday-end-time-1`	string
`timeframe-days-of-week-array[].timeframe-weekly-monday-begin-time-2`	string
`timeframe-days-of-week-array[].timeframe-weekly-monday-end-time-2`	string
`timeframe-days-of-week-array[].timeframe-weekly-tuesday-begin-time-1`	string
`timeframe-days-of-week-array[].timeframe-weekly-tuesday-end-time-1`	string
`timeframe-days-of-week-array[].timeframe-weekly-tuesday-begin-time-2`	string
`timeframe-days-of-week-array[].timeframe-weekly-tuesday-end-time-2`	string
`timeframe-days-of-week-array[].timeframe-weekly-wednesday-begin-time-1`	string
`timeframe-days-of-week-array[].timeframe-weekly-wednesday-end-time-1`	string
`timeframe-days-of-week-array[].timeframe-weekly-wednesday-begin-time-2`	string
`timeframe-days-of-week-array[].timeframe-weekly-wednesday-end-time-2`	string
`timeframe-days-of-week-array[].timeframe-weekly-thursday-begin-time-1`	string
`timeframe-days-of-week-array[].timeframe-weekly-thursday-end-time-1`	string
`timeframe-days-of-week-array[].timeframe-weekly-thursday-begin-time-2`	string
`timeframe-days-of-week-array[].timeframe-weekly-thursday-end-time-2`	string
`timeframe-days-of-week-array[].timeframe-weekly-friday-begin-time-1`	string
`timeframe-days-of-week-array[].timeframe-weekly-friday-end-time-1`	string
`timeframe-days-of-week-array[].timeframe-weekly-friday-begin-time-2`	string
`timeframe-days-of-week-array[].timeframe-weekly-friday-end-time-2`	string
`timeframe-days-of-week-array[].timeframe-weekly-saturday-begin-time-1`	string
`timeframe-days-of-week-array[].timeframe-weekly-saturday-end-time-1`	string
`timeframe-days-of-week-array[].timeframe-weekly-saturday-begin-time-2`	string
`timeframe-days-of-week-array[].timeframe-weekly-saturday-end-time-2`	string
`timeframe-days-of-week-array[].timeframe-recurrence-type` required	string
`timeframe-days-of-week-array[].timeframe-recurrence-begin-date` required	string	Timeframe recurrence begin (date).
`timeframe-days-of-week-array[].timeframe-recurrence-custom-interval` required	string
`timeframe-days-of-week-array[].timeframe-recurrence-custom-interval-count` required	string	Number of timeframe recurrence custom interval.
`timeframe-days-of-week-array[].timeframe-recurrence-custom-interval-option` required	string
`timeframe-days-of-week-array[].timeframe-recurrence-end-option` required	string
`timeframe-days-of-week-array[].timeframe-recurrence-end-date` required	string	Timeframe recurrence end (date).
`timeframe-days-of-week-array[].timeframe-expiry-datetime`	string	Timeframe expiry (date and time).
`timeframe-days-of-week-array[].domain`	string	The account the item belongs to.
`timeframe-days-of-week-array[].timeframe-next-observance-datetime`	array of number	Timeframe next observance (date and time).
`timeframe-days-of-week-array[].timeframe-recurrence-rrule`	string
`timeframe-days-of-week-array[].timeframe-is-v1`	boolean

Example request

curl -X PUT "https://api.noodlevoice.com/ns-api/v2/domains/~/timeframes/{id}" \
  -H "Authorization: Bearer $NOODLEVOICE_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "update-only": "string"
  }'

const res = await fetch("https://api.noodlevoice.com/ns-api/v2/domains/~/timeframes/{id}", {
  method: "PUT",
  headers: {
    Authorization: "Bearer " + process.env.NOODLEVOICE_KEY,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "update-only": "string"
  }),
});
const data = await res.json();

import os, requests

r = requests.put(
    "https://api.noodlevoice.com/ns-api/v2/domains/~/timeframes/{id}",
    headers={"Authorization": "Bearer " + os.environ["NOODLEVOICE_KEY"]},
    json={
        "update-only": "string"
    },
)
print(r.status_code, r.json())

Response 200

Returns a status code with a short JSON message.

Other responses: 400, 401, 404. See errors.

Change a time frame's type

PUT/domains/~/timeframes/{id}

Converts a time frame to a different type, for example from specific dates to custom.

Write Key Admin switch: Schedules (time frames), Write.

Parameters

Name	In	Type	Notes
`id` required	path	string	The ID of the item, as returned when you list or create it.

Request body application/json

Field	Type	Notes
`type` required	string	The kind of item.

Example request

curl -X PUT "https://api.noodlevoice.com/ns-api/v2/domains/~/timeframes/{id}" \
  -H "Authorization: Bearer $NOODLEVOICE_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "type": "string"
  }'

const res = await fetch("https://api.noodlevoice.com/ns-api/v2/domains/~/timeframes/{id}", {
  method: "PUT",
  headers: {
    Authorization: "Bearer " + process.env.NOODLEVOICE_KEY,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "type": "string"
  }),
});
const data = await res.json();

import os, requests

r = requests.put(
    "https://api.noodlevoice.com/ns-api/v2/domains/~/timeframes/{id}",
    headers={"Authorization": "Bearer " + os.environ["NOODLEVOICE_KEY"]},
    json={
        "type": "string"
    },
)
print(r.status_code, r.json())

Response 200

Returns a status code with a short JSON message.

Replace a time frame's date ranges

PUT/domains/~/timeframes/{id}

Replaces every date range in a specific dates time frame with the ones you send.

Write Key Admin switch: Schedules (time frames), Write.

Parameters

Name	In	Type	Notes
`id` required	path	string	The ID of the item, as returned when you list or create it.

Request body application/json

Field	Type	Notes
`timeframe-specific-dates-array`	array of object
`timeframe-specific-dates-array[].timeframe-id`	string	The time frame's ID.
`timeframe-specific-dates-array[].timeframe-parent-id`	string	ID of the timeframe parent.
`timeframe-specific-dates-array[].ordinal-order`	number
`timeframe-specific-dates-array[].timeframe-specific-dates-begin-date` required	string	Timeframe specific dates begin (date).
`timeframe-specific-dates-array[].timeframe-specific-dates-begin-time` required	string
`timeframe-specific-dates-array[].timeframe-specific-dates-end-date` required	string	Timeframe specific dates end (date).
`timeframe-specific-dates-array[].timeframe-specific-dates-end-time` required	string
`timeframe-specific-dates-array[].timeframe-recurrence-type` required	string
`timeframe-specific-dates-array[].timeframe-recurrence-custom-interval` required	string
`timeframe-specific-dates-array[].timeframe-recurrence-custom-interval-count` required	string	Number of timeframe recurrence custom interval.
`timeframe-specific-dates-array[].timeframe-recurrence-custom-interval-option` required	string
`timeframe-specific-dates-array[].timeframe-recurrence-end-option` required	string
`timeframe-specific-dates-array[].timeframe-recurrence-end-date` required	string	Timeframe recurrence end (date).
`timeframe-specific-dates-array[].timeframe-expiry-datetime`	string	Timeframe expiry (date and time).
`timeframe-specific-dates-array[].domain`	string	The account the item belongs to.
`timeframe-specific-dates-array[].timeframe-recurrence-rrule`	string
`timeframe-specific-dates-array[].timeframe-next-observance-datetime`	array of number	Timeframe next observance (date and time).
`timeframe-specific-dates-array[].timeframe-is-v1`	boolean

Example request

curl -X PUT "https://api.noodlevoice.com/ns-api/v2/domains/~/timeframes/{id}" \
  -H "Authorization: Bearer $NOODLEVOICE_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "timeframe-specific-dates-array": [
      {
        "timeframe-specific-dates-begin-date": "2026-11-02",
        "timeframe-specific-dates-begin-time": "string",
        "timeframe-specific-dates-end-date": "2026-11-02",
        "timeframe-specific-dates-end-time": "string",
        "timeframe-recurrence-type": "string",
        "timeframe-recurrence-custom-interval-count": "string",
        "timeframe-recurrence-custom-interval": "string",
        "timeframe-recurrence-custom-interval-option": "string",
        "timeframe-recurrence-end-option": "string",
        "timeframe-recurrence-end-date": "2026-11-02"
      }
    ]
  }'

const res = await fetch("https://api.noodlevoice.com/ns-api/v2/domains/~/timeframes/{id}", {
  method: "PUT",
  headers: {
    Authorization: "Bearer " + process.env.NOODLEVOICE_KEY,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "timeframe-specific-dates-array": [
      {
        "timeframe-specific-dates-begin-date": "2026-11-02",
        "timeframe-specific-dates-begin-time": "string",
        "timeframe-specific-dates-end-date": "2026-11-02",
        "timeframe-specific-dates-end-time": "string",
        "timeframe-recurrence-type": "string",
        "timeframe-recurrence-custom-interval-count": "string",
        "timeframe-recurrence-custom-interval": "string",
        "timeframe-recurrence-custom-interval-option": "string",
        "timeframe-recurrence-end-option": "string",
        "timeframe-recurrence-end-date": "2026-11-02"
      }
    ]
  }),
});
const data = await res.json();

import os, requests

r = requests.put(
    "https://api.noodlevoice.com/ns-api/v2/domains/~/timeframes/{id}",
    headers={"Authorization": "Bearer " + os.environ["NOODLEVOICE_KEY"]},
    json={
        "timeframe-specific-dates-array": [
            {
                "timeframe-specific-dates-begin-date": "2026-11-02",
                "timeframe-specific-dates-begin-time": "string",
                "timeframe-specific-dates-end-date": "2026-11-02",
                "timeframe-specific-dates-end-time": "string",
                "timeframe-recurrence-type": "string",
                "timeframe-recurrence-custom-interval-count": "string",
                "timeframe-recurrence-custom-interval": "string",
                "timeframe-recurrence-custom-interval-option": "string",
                "timeframe-recurrence-end-option": "string",
                "timeframe-recurrence-end-date": "2026-11-02"
            }
        ]
    },
)
print(r.status_code, r.json())

Response 200

Returns a status code with a short JSON message.

Remove a holiday from a time frame

DELETE/domains/~/timeframes/{id}

Deletes one holiday from a holidays time frame. Send its child id in the body.

Write Key Admin switch: Schedules (time frames), Write.

Parameters

Name	In	Type	Notes
`id` required	path	string	The ID of the item, as returned when you list or create it.

Request body application/json

Field	Type	Notes
`child_id` required	string	The ID of the entry inside the time frame.

Example request

curl -X DELETE "https://api.noodlevoice.com/ns-api/v2/domains/~/timeframes/{id}" \
  -H "Authorization: Bearer $NOODLEVOICE_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "child_id": "string"
  }'

const res = await fetch("https://api.noodlevoice.com/ns-api/v2/domains/~/timeframes/{id}", {
  method: "DELETE",
  headers: {
    Authorization: "Bearer " + process.env.NOODLEVOICE_KEY,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "child_id": "string"
  }),
});
const data = await res.json();

import os, requests

r = requests.delete(
    "https://api.noodlevoice.com/ns-api/v2/domains/~/timeframes/{id}",
    headers={"Authorization": "Bearer " + os.environ["NOODLEVOICE_KEY"]},
    json={
        "child_id": "string"
    },
)
print(r.status_code, r.json())

Response 202

Returns a status code with a short JSON message.

Other responses: 400, 401, 404. See errors.

Remove an entry from a custom time frame

DELETE/domains/~/timeframes/{id}

Deletes one entry from a custom time frame. Send its child id in the body.

Write Key Admin switch: Schedules (time frames), Write.

Parameters

Name	In	Type	Notes
`id` required	path	string	The ID of the item, as returned when you list or create it.

Request body application/json

Field	Type	Notes
`child_id` required	string	The ID of the entry inside the time frame.

Example request

curl -X DELETE "https://api.noodlevoice.com/ns-api/v2/domains/~/timeframes/{id}" \
  -H "Authorization: Bearer $NOODLEVOICE_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "child_id": "string"
  }'

const res = await fetch("https://api.noodlevoice.com/ns-api/v2/domains/~/timeframes/{id}", {
  method: "DELETE",
  headers: {
    Authorization: "Bearer " + process.env.NOODLEVOICE_KEY,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "child_id": "string"
  }),
});
const data = await res.json();

import os, requests

r = requests.delete(
    "https://api.noodlevoice.com/ns-api/v2/domains/~/timeframes/{id}",
    headers={"Authorization": "Bearer " + os.environ["NOODLEVOICE_KEY"]},
    json={
        "child_id": "string"
    },
)
print(r.status_code, r.json())

Response 202

Returns a status code with a short JSON message.

Other responses: 400, 401, 404. See errors.

Delete a time frame

DELETE/domains/~/timeframes/{id}

Deletes a shared time frame and everything in it.

Write Key Admin switch: Schedules (time frames), Write.

Parameters

Name	In	Type	Notes
`id` required	path	string	The ID of the item, as returned when you list or create it.

Example request

curl -X DELETE "https://api.noodlevoice.com/ns-api/v2/domains/~/timeframes/{id}" \
  -H "Authorization: Bearer $NOODLEVOICE_KEY"

const res = await fetch("https://api.noodlevoice.com/ns-api/v2/domains/~/timeframes/{id}", {
  method: "DELETE",
  headers: {
    Authorization: "Bearer " + process.env.NOODLEVOICE_KEY,
  },
});
const data = await res.json();

import os, requests

r = requests.delete(
    "https://api.noodlevoice.com/ns-api/v2/domains/~/timeframes/{id}",
    headers={"Authorization": "Bearer " + os.environ["NOODLEVOICE_KEY"]},
)
print(r.status_code, r.json())

Response 202

Returns a status code with a short JSON message.

Other responses: 400, 401, 404. See errors.

Remove a date range from a time frame

DELETE/domains/~/timeframes/{id}

Deletes one date range from a specific dates time frame. Send its child id in the body.

Write Key Admin switch: Schedules (time frames), Write.

Parameters

Name	In	Type	Notes
`id` required	path	string	The ID of the item, as returned when you list or create it.

Request body application/json

Field	Type	Notes
`child_id` required	string	The ID of the entry inside the time frame.

Example request

curl -X DELETE "https://api.noodlevoice.com/ns-api/v2/domains/~/timeframes/{id}" \
  -H "Authorization: Bearer $NOODLEVOICE_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "child_id": "string"
  }'

const res = await fetch("https://api.noodlevoice.com/ns-api/v2/domains/~/timeframes/{id}", {
  method: "DELETE",
  headers: {
    Authorization: "Bearer " + process.env.NOODLEVOICE_KEY,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "child_id": "string"
  }),
});
const data = await res.json();

import os, requests

r = requests.delete(
    "https://api.noodlevoice.com/ns-api/v2/domains/~/timeframes/{id}",
    headers={"Authorization": "Bearer " + os.environ["NOODLEVOICE_KEY"]},
    json={
        "child_id": "string"
    },
)
print(r.status_code, r.json())

Response 202

Returns a status code with a short JSON message.

Other responses: 400, 401, 404. See errors.

List time frames for a user

GET/domains/~/users/{user}/timeframes

Returns the time frames for one user.

Read Key Admin switch: Schedules (time frames), Read. Read only keys also work.

Parameters

Name	In	Type	Notes
`user` required	path	string	The user ID, usually their extension number, like `1001`. Default `~` Min length 0 Max length 16

Example request

curl -X GET "https://api.noodlevoice.com/ns-api/v2/domains/~/users/1001/timeframes" \
  -H "Authorization: Bearer $NOODLEVOICE_KEY"

const res = await fetch("https://api.noodlevoice.com/ns-api/v2/domains/~/users/1001/timeframes", {
  method: "GET",
  headers: {
    Authorization: "Bearer " + process.env.NOODLEVOICE_KEY,
  },
});
const data = await res.json();

import os, requests

r = requests.get(
    "https://api.noodlevoice.com/ns-api/v2/domains/~/users/1001/timeframes",
    headers={"Authorization": "Bearer " + os.environ["NOODLEVOICE_KEY"]},
)
print(r.status_code, r.json())

Response 200

[
  {
    "timeframe-id": "string",
    "timeframe-name": "Front Desk",
    "user": "1001",
    "domain": "string",
    "timeframe-type": "string",
    "timeframe-specific-dates-array": [
      {}
    ],
    "timeframe-holiday-array": [
      {}
    ],
    "timeframe-days-of-week-array": [
      {}
    ]
  }
]

Response fields (96)

Field	Type	Notes
`timeframe-id`	string	The time frame's ID.
`timeframe-name`	string	Name of the time frame.
`user`	string	The user ID (extension).
`domain`	string	The account the item belongs to.
`timeframe-type`	string	What kind of time frame it is.
`timeframe-specific-dates-array`	array of object
`timeframe-specific-dates-array[].timeframe-id`	string	The time frame's ID.
`timeframe-specific-dates-array[].timeframe-parent-id`	string	ID of the timeframe parent.
`timeframe-specific-dates-array[].ordinal-order`	number
`timeframe-specific-dates-array[].timeframe-specific-dates-begin-date`	string	Timeframe specific dates begin (date).
`timeframe-specific-dates-array[].timeframe-specific-dates-begin-time`	string
`timeframe-specific-dates-array[].timeframe-specific-dates-end-date`	string	Timeframe specific dates end (date).
`timeframe-specific-dates-array[].timeframe-specific-dates-end-time`	string
`timeframe-specific-dates-array[].timeframe-recurrence-type`	string
`timeframe-specific-dates-array[].timeframe-recurrence-custom-interval`	string
`timeframe-specific-dates-array[].timeframe-recurrence-custom-interval-count`	string	Number of timeframe recurrence custom interval.
`timeframe-specific-dates-array[].timeframe-recurrence-custom-interval-option`	string
`timeframe-specific-dates-array[].timeframe-recurrence-end-option`	string
`timeframe-specific-dates-array[].timeframe-recurrence-end-date`	string	Timeframe recurrence end (date).
`timeframe-specific-dates-array[].timeframe-expiry-datetime`	string	Timeframe expiry (date and time).
`timeframe-specific-dates-array[].domain`	string	The account the item belongs to.
`timeframe-specific-dates-array[].timeframe-recurrence-rrule`	string
`timeframe-specific-dates-array[].timeframe-next-observance-datetime`	array of number	Timeframe next observance (date and time).
`timeframe-specific-dates-array[].timeframe-is-v1`	boolean
`timeframe-holiday-array`	array of object
`timeframe-holiday-array[].timeframe-id`	string	The time frame's ID.
`timeframe-holiday-array[].timeframe-parent-id`	string	ID of the timeframe parent.
`timeframe-holiday-array[].ordinal-order`	number
`timeframe-holiday-array[].timeframe-holiday-uuid`	string
`timeframe-holiday-array[].timeframe-holiday-name`	string	Name of the timeframe holiday.
`timeframe-holiday-array[].timeframe-holiday-begin-date`	string	Timeframe holiday begin (date).
`timeframe-holiday-array[].country-abbreviation`	string
`timeframe-holiday-array[].state-province-abbreviation`	string
`timeframe-holiday-array[].holiday-api-location-hint`	string
`timeframe-holiday-array[].timeframe-holiday-begin-time-1`	string
`timeframe-holiday-array[].timeframe-holiday-end-time-1`	string
`timeframe-holiday-array[].timeframe-holiday-begin-time-2`	string
`timeframe-holiday-array[].timeframe-holiday-end-time-2`	string
`timeframe-holiday-array[].timeframe-weekly-monday-observance-option`	string
`timeframe-holiday-array[].timeframe-weekly-tuesday-observance-option`	string
`timeframe-holiday-array[].timeframe-weekly-wednesday-observance-option`	string
`timeframe-holiday-array[].timeframe-weekly-thursday-observance-option`	string
`timeframe-holiday-array[].timeframe-weekly-friday-observance-option`	string
`timeframe-holiday-array[].timeframe-weekly-saturday-observance-option`	string
`timeframe-holiday-array[].timeframe-weekly-sunday-observance-option`	string
`timeframe-holiday-array[].timeframe-workweek-list`	string
`timeframe-holiday-array[].timeframe-recurrence-type`	string
`timeframe-holiday-array[].timeframe-recurrence-end-option`	string
`timeframe-holiday-array[].timeframe-recurrence-end-date`	string	Timeframe recurrence end (date).
`timeframe-holiday-array[].timeframe-expiry-datetime`	string	Timeframe expiry (date and time).
`timeframe-holiday-array[].domain`	string	The account the item belongs to.
`timeframe-holiday-array[].timeframe-next-observance-datetime`	array of number	Timeframe next observance (date and time).
`timeframe-days-of-week-array`	array of object
`timeframe-days-of-week-array[].timeframe-id`	string	The time frame's ID.
`timeframe-days-of-week-array[].timeframe-parent-id`	string	ID of the timeframe parent.
`timeframe-days-of-week-array[].ordinal-order`	number
`timeframe-days-of-week-array[].timeframe-weekly-sunday-begin-time-1`	string
`timeframe-days-of-week-array[].timeframe-weekly-sunday-end-time-1`	string
`timeframe-days-of-week-array[].timeframe-weekly-sunday-begin-time-2`	string
`timeframe-days-of-week-array[].timeframe-weekly-sunday-end-time-2`	string
`timeframe-days-of-week-array[].timeframe-weekly-monday-begin-time-1`	string
`timeframe-days-of-week-array[].timeframe-weekly-monday-end-time-1`	string
`timeframe-days-of-week-array[].timeframe-weekly-monday-begin-time-2`	string
`timeframe-days-of-week-array[].timeframe-weekly-monday-end-time-2`	string
`timeframe-days-of-week-array[].timeframe-weekly-tuesday-begin-time-1`	string
`timeframe-days-of-week-array[].timeframe-weekly-tuesday-end-time-1`	string
`timeframe-days-of-week-array[].timeframe-weekly-tuesday-begin-time-2`	string
`timeframe-days-of-week-array[].timeframe-weekly-tuesday-end-time-2`	string
`timeframe-days-of-week-array[].timeframe-weekly-wednesday-begin-time-1`	string
`timeframe-days-of-week-array[].timeframe-weekly-wednesday-end-time-1`	string
`timeframe-days-of-week-array[].timeframe-weekly-wednesday-begin-time-2`	string
`timeframe-days-of-week-array[].timeframe-weekly-wednesday-end-time-2`	string
`timeframe-days-of-week-array[].timeframe-weekly-thursday-begin-time-1`	string
`timeframe-days-of-week-array[].timeframe-weekly-thursday-end-time-1`	string
`timeframe-days-of-week-array[].timeframe-weekly-thursday-begin-time-2`	string
`timeframe-days-of-week-array[].timeframe-weekly-thursday-end-time-2`	string
`timeframe-days-of-week-array[].timeframe-weekly-friday-begin-time-1`	string
`timeframe-days-of-week-array[].timeframe-weekly-friday-end-time-1`	string
`timeframe-days-of-week-array[].timeframe-weekly-friday-begin-time-2`	string
`timeframe-days-of-week-array[].timeframe-weekly-friday-end-time-2`	string
`timeframe-days-of-week-array[].timeframe-weekly-saturday-begin-time-1`	string
`timeframe-days-of-week-array[].timeframe-weekly-saturday-end-time-1`	string
`timeframe-days-of-week-array[].timeframe-weekly-saturday-begin-time-2`	string
`timeframe-days-of-week-array[].timeframe-weekly-saturday-end-time-2`	string
`timeframe-days-of-week-array[].timeframe-recurrence-type`	string
`timeframe-days-of-week-array[].timeframe-recurrence-begin-date`	string	Timeframe recurrence begin (date).
`timeframe-days-of-week-array[].timeframe-recurrence-custom-interval`	string
`timeframe-days-of-week-array[].timeframe-recurrence-custom-interval-count`	string	Number of timeframe recurrence custom interval.
`timeframe-days-of-week-array[].timeframe-recurrence-custom-interval-option`	string
`timeframe-days-of-week-array[].timeframe-recurrence-end-option`	string
`timeframe-days-of-week-array[].timeframe-recurrence-end-date`	string	Timeframe recurrence end (date).
`timeframe-days-of-week-array[].timeframe-expiry-datetime`	string	Timeframe expiry (date and time).
`timeframe-days-of-week-array[].domain`	string	The account the item belongs to.
`timeframe-days-of-week-array[].timeframe-next-observance-datetime`	array of number	Timeframe next observance (date and time).
`timeframe-days-of-week-array[].timeframe-recurrence-rrule`	string
`timeframe-days-of-week-array[].timeframe-is-v1`	boolean

Get a user's time frame

GET/domains/~/users/{user}/timeframes/{id}

Returns one of a user's time frames.

Read Key Admin switch: Schedules (time frames), Read. Read only keys also work.

Parameters

Name	In	Type	Notes
`user` required	path	string	The user ID, usually their extension number, like `1001`. Default `~` Min length 0 Max length 16
`id` required	path	string	The ID of the item, as returned when you list or create it.

Example request

curl -X GET "https://api.noodlevoice.com/ns-api/v2/domains/~/users/1001/timeframes/{id}" \
  -H "Authorization: Bearer $NOODLEVOICE_KEY"

const res = await fetch("https://api.noodlevoice.com/ns-api/v2/domains/~/users/1001/timeframes/{id}", {
  method: "GET",
  headers: {
    Authorization: "Bearer " + process.env.NOODLEVOICE_KEY,
  },
});
const data = await res.json();

import os, requests

r = requests.get(
    "https://api.noodlevoice.com/ns-api/v2/domains/~/users/1001/timeframes/{id}",
    headers={"Authorization": "Bearer " + os.environ["NOODLEVOICE_KEY"]},
)
print(r.status_code, r.json())

Response 200

Returns a status code with a short JSON message.

Create a specific dates time frame for a user

POST/domains/~/users/{user}/timeframes

Adds a time frame for one user made of date and time ranges.

Write Key Admin switch: Schedules (time frames), Write.

Parameters

Name	In	Type	Notes
`user` required	path	string	The user ID, usually their extension number, like `1001`. Default `~` Min length 0 Max length 16

Request body application/json

Field	Type	Notes
`synchronous` required	string	Set to `yes` to wait until the change is finished before the response comes back. One of: `yes`, `no` Default `no`
`timeframe-name`	string	Name of the time frame.
`timeframe-type`	string	What kind of time frame it is.
`timeframe-specific-dates-array`	array of object
`timeframe-specific-dates-array[].timeframe-id`	string	The time frame's ID.
`timeframe-specific-dates-array[].timeframe-parent-id`	string	ID of the timeframe parent.
`timeframe-specific-dates-array[].ordinal-order`	number
`timeframe-specific-dates-array[].timeframe-specific-dates-begin-date` required	string	Timeframe specific dates begin (date).
`timeframe-specific-dates-array[].timeframe-specific-dates-begin-time` required	string
`timeframe-specific-dates-array[].timeframe-specific-dates-end-date` required	string	Timeframe specific dates end (date).
`timeframe-specific-dates-array[].timeframe-specific-dates-end-time` required	string
`timeframe-specific-dates-array[].timeframe-recurrence-type` required	string
`timeframe-specific-dates-array[].timeframe-recurrence-custom-interval` required	string
`timeframe-specific-dates-array[].timeframe-recurrence-custom-interval-count` required	string	Number of timeframe recurrence custom interval.
`timeframe-specific-dates-array[].timeframe-recurrence-custom-interval-option` required	string
`timeframe-specific-dates-array[].timeframe-recurrence-end-option` required	string
`timeframe-specific-dates-array[].timeframe-recurrence-end-date` required	string	Timeframe recurrence end (date).
`timeframe-specific-dates-array[].timeframe-expiry-datetime`	string	Timeframe expiry (date and time).
`timeframe-specific-dates-array[].domain`	string	The account the item belongs to.
`timeframe-specific-dates-array[].timeframe-recurrence-rrule`	string
`timeframe-specific-dates-array[].timeframe-next-observance-datetime`	array of number	Timeframe next observance (date and time).
`timeframe-specific-dates-array[].timeframe-is-v1`	boolean

Example request

curl -X POST "https://api.noodlevoice.com/ns-api/v2/domains/~/users/1001/timeframes" \
  -H "Authorization: Bearer $NOODLEVOICE_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "synchronous": "yes"
  }'

const res = await fetch("https://api.noodlevoice.com/ns-api/v2/domains/~/users/1001/timeframes", {
  method: "POST",
  headers: {
    Authorization: "Bearer " + process.env.NOODLEVOICE_KEY,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "synchronous": "yes"
  }),
});
const data = await res.json();

import os, requests

r = requests.post(
    "https://api.noodlevoice.com/ns-api/v2/domains/~/users/1001/timeframes",
    headers={"Authorization": "Bearer " + os.environ["NOODLEVOICE_KEY"]},
    json={
        "synchronous": "yes"
    },
)
print(r.status_code, r.json())

Response 200

{
  "timeframe-name": "Front Desk",
  "timeframe-type": "string",
  "timeframe-specific-dates-array": [
    {}
  ],
  "timeframe-days-of-week-array": [
    {}
  ]
}

Response fields (65)

Field	Type	Notes
`timeframe-name`	string	Name of the time frame.
`timeframe-type`	string	What kind of time frame it is.
`timeframe-specific-dates-array`	array of object
`timeframe-specific-dates-array[].timeframe-id`	string	The time frame's ID.
`timeframe-specific-dates-array[].timeframe-parent-id`	string	ID of the timeframe parent.
`timeframe-specific-dates-array[].ordinal-order`	number
`timeframe-specific-dates-array[].timeframe-specific-dates-begin-date`	string	Timeframe specific dates begin (date).
`timeframe-specific-dates-array[].timeframe-specific-dates-begin-time`	string
`timeframe-specific-dates-array[].timeframe-specific-dates-end-date`	string	Timeframe specific dates end (date).
`timeframe-specific-dates-array[].timeframe-specific-dates-end-time`	string
`timeframe-specific-dates-array[].timeframe-recurrence-type`	string
`timeframe-specific-dates-array[].timeframe-recurrence-custom-interval`	string
`timeframe-specific-dates-array[].timeframe-recurrence-custom-interval-count`	string	Number of timeframe recurrence custom interval.
`timeframe-specific-dates-array[].timeframe-recurrence-custom-interval-option`	string
`timeframe-specific-dates-array[].timeframe-recurrence-end-option`	string
`timeframe-specific-dates-array[].timeframe-recurrence-end-date`	string	Timeframe recurrence end (date).
`timeframe-specific-dates-array[].timeframe-expiry-datetime`	string	Timeframe expiry (date and time).
`timeframe-specific-dates-array[].domain`	string	The account the item belongs to.
`timeframe-specific-dates-array[].timeframe-recurrence-rrule`	string
`timeframe-specific-dates-array[].timeframe-next-observance-datetime`	array of number	Timeframe next observance (date and time).
`timeframe-specific-dates-array[].timeframe-is-v1`	boolean
`timeframe-days-of-week-array`	array of object
`timeframe-days-of-week-array[].timeframe-id`	string	The time frame's ID.
`timeframe-days-of-week-array[].timeframe-parent-id`	string	ID of the timeframe parent.
`timeframe-days-of-week-array[].ordinal-order`	number
`timeframe-days-of-week-array[].timeframe-weekly-sunday-begin-time-1`	string
`timeframe-days-of-week-array[].timeframe-weekly-sunday-end-time-1`	string
`timeframe-days-of-week-array[].timeframe-weekly-sunday-begin-time-2`	string
`timeframe-days-of-week-array[].timeframe-weekly-sunday-end-time-2`	string
`timeframe-days-of-week-array[].timeframe-weekly-monday-begin-time-1`	string
`timeframe-days-of-week-array[].timeframe-weekly-monday-end-time-1`	string
`timeframe-days-of-week-array[].timeframe-weekly-monday-begin-time-2`	string
`timeframe-days-of-week-array[].timeframe-weekly-monday-end-time-2`	string
`timeframe-days-of-week-array[].timeframe-weekly-tuesday-begin-time-1`	string
`timeframe-days-of-week-array[].timeframe-weekly-tuesday-end-time-1`	string
`timeframe-days-of-week-array[].timeframe-weekly-tuesday-begin-time-2`	string
`timeframe-days-of-week-array[].timeframe-weekly-tuesday-end-time-2`	string
`timeframe-days-of-week-array[].timeframe-weekly-wednesday-begin-time-1`	string
`timeframe-days-of-week-array[].timeframe-weekly-wednesday-end-time-1`	string
`timeframe-days-of-week-array[].timeframe-weekly-wednesday-begin-time-2`	string
`timeframe-days-of-week-array[].timeframe-weekly-wednesday-end-time-2`	string
`timeframe-days-of-week-array[].timeframe-weekly-thursday-begin-time-1`	string
`timeframe-days-of-week-array[].timeframe-weekly-thursday-end-time-1`	string
`timeframe-days-of-week-array[].timeframe-weekly-thursday-begin-time-2`	string
`timeframe-days-of-week-array[].timeframe-weekly-thursday-end-time-2`	string
`timeframe-days-of-week-array[].timeframe-weekly-friday-begin-time-1`	string
`timeframe-days-of-week-array[].timeframe-weekly-friday-end-time-1`	string
`timeframe-days-of-week-array[].timeframe-weekly-friday-begin-time-2`	string
`timeframe-days-of-week-array[].timeframe-weekly-friday-end-time-2`	string
`timeframe-days-of-week-array[].timeframe-weekly-saturday-begin-time-1`	string
`timeframe-days-of-week-array[].timeframe-weekly-saturday-end-time-1`	string
`timeframe-days-of-week-array[].timeframe-weekly-saturday-begin-time-2`	string
`timeframe-days-of-week-array[].timeframe-weekly-saturday-end-time-2`	string
`timeframe-days-of-week-array[].timeframe-recurrence-type`	string
`timeframe-days-of-week-array[].timeframe-recurrence-begin-date`	string	Timeframe recurrence begin (date).
`timeframe-days-of-week-array[].timeframe-recurrence-custom-interval`	string
`timeframe-days-of-week-array[].timeframe-recurrence-custom-interval-count`	string	Number of timeframe recurrence custom interval.
`timeframe-days-of-week-array[].timeframe-recurrence-custom-interval-option`	string
`timeframe-days-of-week-array[].timeframe-recurrence-end-option`	string
`timeframe-days-of-week-array[].timeframe-recurrence-end-date`	string	Timeframe recurrence end (date).
`timeframe-days-of-week-array[].timeframe-expiry-datetime`	string	Timeframe expiry (date and time).
`timeframe-days-of-week-array[].domain`	string	The account the item belongs to.
`timeframe-days-of-week-array[].timeframe-next-observance-datetime`	array of number	Timeframe next observance (date and time).
`timeframe-days-of-week-array[].timeframe-recurrence-rrule`	string
`timeframe-days-of-week-array[].timeframe-is-v1`	boolean

Create a days of week time frame for a user

POST/domains/~/users/{user}/timeframes

Adds a weekly hours time frame for one user.

Write Key Admin switch: Schedules (time frames), Write.

Parameters

Name	In	Type	Notes
`user` required	path	string	The user ID, usually their extension number, like `1001`. Default `~` Min length 0 Max length 16

Request body application/json

Field	Type	Notes
`synchronous` required	string	Set to `yes` to wait until the change is finished before the response comes back. One of: `yes`, `no` Default `no`
`timeframe-name`	string	Name of the time frame.
`timeframe-type`	string	What kind of time frame it is.
`timeframe-days-of-week-array`	array of object
`timeframe-days-of-week-array[].timeframe-id`	string	The time frame's ID.
`timeframe-days-of-week-array[].timeframe-parent-id`	string	ID of the timeframe parent.
`timeframe-days-of-week-array[].ordinal-order`	number
`timeframe-days-of-week-array[].timeframe-weekly-sunday-begin-time-1`	string
`timeframe-days-of-week-array[].timeframe-weekly-sunday-end-time-1`	string
`timeframe-days-of-week-array[].timeframe-weekly-sunday-begin-time-2`	string
`timeframe-days-of-week-array[].timeframe-weekly-sunday-end-time-2`	string
`timeframe-days-of-week-array[].timeframe-weekly-monday-begin-time-1`	string
`timeframe-days-of-week-array[].timeframe-weekly-monday-end-time-1`	string
`timeframe-days-of-week-array[].timeframe-weekly-monday-begin-time-2`	string
`timeframe-days-of-week-array[].timeframe-weekly-monday-end-time-2`	string
`timeframe-days-of-week-array[].timeframe-weekly-tuesday-begin-time-1`	string
`timeframe-days-of-week-array[].timeframe-weekly-tuesday-end-time-1`	string
`timeframe-days-of-week-array[].timeframe-weekly-tuesday-begin-time-2`	string
`timeframe-days-of-week-array[].timeframe-weekly-tuesday-end-time-2`	string
`timeframe-days-of-week-array[].timeframe-weekly-wednesday-begin-time-1`	string
`timeframe-days-of-week-array[].timeframe-weekly-wednesday-end-time-1`	string
`timeframe-days-of-week-array[].timeframe-weekly-wednesday-begin-time-2`	string
`timeframe-days-of-week-array[].timeframe-weekly-wednesday-end-time-2`	string
`timeframe-days-of-week-array[].timeframe-weekly-thursday-begin-time-1`	string
`timeframe-days-of-week-array[].timeframe-weekly-thursday-end-time-1`	string
`timeframe-days-of-week-array[].timeframe-weekly-thursday-begin-time-2`	string
`timeframe-days-of-week-array[].timeframe-weekly-thursday-end-time-2`	string
`timeframe-days-of-week-array[].timeframe-weekly-friday-begin-time-1`	string
`timeframe-days-of-week-array[].timeframe-weekly-friday-end-time-1`	string
`timeframe-days-of-week-array[].timeframe-weekly-friday-begin-time-2`	string
`timeframe-days-of-week-array[].timeframe-weekly-friday-end-time-2`	string
`timeframe-days-of-week-array[].timeframe-weekly-saturday-begin-time-1`	string
`timeframe-days-of-week-array[].timeframe-weekly-saturday-end-time-1`	string
`timeframe-days-of-week-array[].timeframe-weekly-saturday-begin-time-2`	string
`timeframe-days-of-week-array[].timeframe-weekly-saturday-end-time-2`	string
`timeframe-days-of-week-array[].timeframe-recurrence-type` required	string
`timeframe-days-of-week-array[].timeframe-recurrence-begin-date` required	string	Timeframe recurrence begin (date).
`timeframe-days-of-week-array[].timeframe-recurrence-custom-interval` required	string
`timeframe-days-of-week-array[].timeframe-recurrence-custom-interval-count` required	string	Number of timeframe recurrence custom interval.
`timeframe-days-of-week-array[].timeframe-recurrence-custom-interval-option` required	string
`timeframe-days-of-week-array[].timeframe-recurrence-end-option` required	string
`timeframe-days-of-week-array[].timeframe-recurrence-end-date` required	string	Timeframe recurrence end (date).
`timeframe-days-of-week-array[].timeframe-expiry-datetime`	string	Timeframe expiry (date and time).
`timeframe-days-of-week-array[].domain`	string	The account the item belongs to.
`timeframe-days-of-week-array[].timeframe-next-observance-datetime`	array of number	Timeframe next observance (date and time).
`timeframe-days-of-week-array[].timeframe-recurrence-rrule`	string
`timeframe-days-of-week-array[].timeframe-is-v1`	boolean

Example request

curl -X POST "https://api.noodlevoice.com/ns-api/v2/domains/~/users/1001/timeframes" \
  -H "Authorization: Bearer $NOODLEVOICE_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "synchronous": "yes"
  }'

const res = await fetch("https://api.noodlevoice.com/ns-api/v2/domains/~/users/1001/timeframes", {
  method: "POST",
  headers: {
    Authorization: "Bearer " + process.env.NOODLEVOICE_KEY,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "synchronous": "yes"
  }),
});
const data = await res.json();

import os, requests

r = requests.post(
    "https://api.noodlevoice.com/ns-api/v2/domains/~/users/1001/timeframes",
    headers={"Authorization": "Bearer " + os.environ["NOODLEVOICE_KEY"]},
    json={
        "synchronous": "yes"
    },
)
print(r.status_code, r.json())

Response 200

{
  "timeframe-id": "string",
  "timeframe-name": "Front Desk",
  "user": "1001",
  "domain": "string",
  "timeframe-type": "string",
  "timeframe-specific-dates-array": [
    {}
  ],
  "timeframe-holiday-array": [
    {}
  ],
  "timeframe-days-of-week-array": [
    {}
  ]
}

Response fields (96)

Field	Type	Notes
`timeframe-id`	string	The time frame's ID.
`timeframe-name`	string	Name of the time frame.
`user`	string	The user ID (extension).
`domain`	string	The account the item belongs to.
`timeframe-type`	string	What kind of time frame it is.
`timeframe-specific-dates-array`	array of object
`timeframe-specific-dates-array[].timeframe-id`	string	The time frame's ID.
`timeframe-specific-dates-array[].timeframe-parent-id`	string	ID of the timeframe parent.
`timeframe-specific-dates-array[].ordinal-order`	number
`timeframe-specific-dates-array[].timeframe-specific-dates-begin-date`	string	Timeframe specific dates begin (date).
`timeframe-specific-dates-array[].timeframe-specific-dates-begin-time`	string
`timeframe-specific-dates-array[].timeframe-specific-dates-end-date`	string	Timeframe specific dates end (date).
`timeframe-specific-dates-array[].timeframe-specific-dates-end-time`	string
`timeframe-specific-dates-array[].timeframe-recurrence-type`	string
`timeframe-specific-dates-array[].timeframe-recurrence-custom-interval`	string
`timeframe-specific-dates-array[].timeframe-recurrence-custom-interval-count`	string	Number of timeframe recurrence custom interval.
`timeframe-specific-dates-array[].timeframe-recurrence-custom-interval-option`	string
`timeframe-specific-dates-array[].timeframe-recurrence-end-option`	string
`timeframe-specific-dates-array[].timeframe-recurrence-end-date`	string	Timeframe recurrence end (date).
`timeframe-specific-dates-array[].timeframe-expiry-datetime`	string	Timeframe expiry (date and time).
`timeframe-specific-dates-array[].domain`	string	The account the item belongs to.
`timeframe-specific-dates-array[].timeframe-recurrence-rrule`	string
`timeframe-specific-dates-array[].timeframe-next-observance-datetime`	array of number	Timeframe next observance (date and time).
`timeframe-specific-dates-array[].timeframe-is-v1`	boolean
`timeframe-holiday-array`	array of object
`timeframe-holiday-array[].timeframe-id`	string	The time frame's ID.
`timeframe-holiday-array[].timeframe-parent-id`	string	ID of the timeframe parent.
`timeframe-holiday-array[].ordinal-order`	number
`timeframe-holiday-array[].timeframe-holiday-uuid`	string
`timeframe-holiday-array[].timeframe-holiday-name`	string	Name of the timeframe holiday.
`timeframe-holiday-array[].timeframe-holiday-begin-date`	string	Timeframe holiday begin (date).
`timeframe-holiday-array[].country-abbreviation`	string
`timeframe-holiday-array[].state-province-abbreviation`	string
`timeframe-holiday-array[].holiday-api-location-hint`	string
`timeframe-holiday-array[].timeframe-holiday-begin-time-1`	string
`timeframe-holiday-array[].timeframe-holiday-end-time-1`	string
`timeframe-holiday-array[].timeframe-holiday-begin-time-2`	string
`timeframe-holiday-array[].timeframe-holiday-end-time-2`	string
`timeframe-holiday-array[].timeframe-weekly-monday-observance-option`	string
`timeframe-holiday-array[].timeframe-weekly-tuesday-observance-option`	string
`timeframe-holiday-array[].timeframe-weekly-wednesday-observance-option`	string
`timeframe-holiday-array[].timeframe-weekly-thursday-observance-option`	string
`timeframe-holiday-array[].timeframe-weekly-friday-observance-option`	string
`timeframe-holiday-array[].timeframe-weekly-saturday-observance-option`	string
`timeframe-holiday-array[].timeframe-weekly-sunday-observance-option`	string
`timeframe-holiday-array[].timeframe-workweek-list`	string
`timeframe-holiday-array[].timeframe-recurrence-type`	string
`timeframe-holiday-array[].timeframe-recurrence-end-option`	string
`timeframe-holiday-array[].timeframe-recurrence-end-date`	string	Timeframe recurrence end (date).
`timeframe-holiday-array[].timeframe-expiry-datetime`	string	Timeframe expiry (date and time).
`timeframe-holiday-array[].domain`	string	The account the item belongs to.
`timeframe-holiday-array[].timeframe-next-observance-datetime`	array of number	Timeframe next observance (date and time).
`timeframe-days-of-week-array`	array of object
`timeframe-days-of-week-array[].timeframe-id`	string	The time frame's ID.
`timeframe-days-of-week-array[].timeframe-parent-id`	string	ID of the timeframe parent.
`timeframe-days-of-week-array[].ordinal-order`	number
`timeframe-days-of-week-array[].timeframe-weekly-sunday-begin-time-1`	string
`timeframe-days-of-week-array[].timeframe-weekly-sunday-end-time-1`	string
`timeframe-days-of-week-array[].timeframe-weekly-sunday-begin-time-2`	string
`timeframe-days-of-week-array[].timeframe-weekly-sunday-end-time-2`	string
`timeframe-days-of-week-array[].timeframe-weekly-monday-begin-time-1`	string
`timeframe-days-of-week-array[].timeframe-weekly-monday-end-time-1`	string
`timeframe-days-of-week-array[].timeframe-weekly-monday-begin-time-2`	string
`timeframe-days-of-week-array[].timeframe-weekly-monday-end-time-2`	string
`timeframe-days-of-week-array[].timeframe-weekly-tuesday-begin-time-1`	string
`timeframe-days-of-week-array[].timeframe-weekly-tuesday-end-time-1`	string
`timeframe-days-of-week-array[].timeframe-weekly-tuesday-begin-time-2`	string
`timeframe-days-of-week-array[].timeframe-weekly-tuesday-end-time-2`	string
`timeframe-days-of-week-array[].timeframe-weekly-wednesday-begin-time-1`	string
`timeframe-days-of-week-array[].timeframe-weekly-wednesday-end-time-1`	string
`timeframe-days-of-week-array[].timeframe-weekly-wednesday-begin-time-2`	string
`timeframe-days-of-week-array[].timeframe-weekly-wednesday-end-time-2`	string
`timeframe-days-of-week-array[].timeframe-weekly-thursday-begin-time-1`	string
`timeframe-days-of-week-array[].timeframe-weekly-thursday-end-time-1`	string
`timeframe-days-of-week-array[].timeframe-weekly-thursday-begin-time-2`	string
`timeframe-days-of-week-array[].timeframe-weekly-thursday-end-time-2`	string
`timeframe-days-of-week-array[].timeframe-weekly-friday-begin-time-1`	string
`timeframe-days-of-week-array[].timeframe-weekly-friday-end-time-1`	string
`timeframe-days-of-week-array[].timeframe-weekly-friday-begin-time-2`	string
`timeframe-days-of-week-array[].timeframe-weekly-friday-end-time-2`	string
`timeframe-days-of-week-array[].timeframe-weekly-saturday-begin-time-1`	string
`timeframe-days-of-week-array[].timeframe-weekly-saturday-end-time-1`	string
`timeframe-days-of-week-array[].timeframe-weekly-saturday-begin-time-2`	string
`timeframe-days-of-week-array[].timeframe-weekly-saturday-end-time-2`	string
`timeframe-days-of-week-array[].timeframe-recurrence-type`	string
`timeframe-days-of-week-array[].timeframe-recurrence-begin-date`	string	Timeframe recurrence begin (date).
`timeframe-days-of-week-array[].timeframe-recurrence-custom-interval`	string
`timeframe-days-of-week-array[].timeframe-recurrence-custom-interval-count`	string	Number of timeframe recurrence custom interval.
`timeframe-days-of-week-array[].timeframe-recurrence-custom-interval-option`	string
`timeframe-days-of-week-array[].timeframe-recurrence-end-option`	string
`timeframe-days-of-week-array[].timeframe-recurrence-end-date`	string	Timeframe recurrence end (date).
`timeframe-days-of-week-array[].timeframe-expiry-datetime`	string	Timeframe expiry (date and time).
`timeframe-days-of-week-array[].domain`	string	The account the item belongs to.
`timeframe-days-of-week-array[].timeframe-next-observance-datetime`	array of number	Timeframe next observance (date and time).
`timeframe-days-of-week-array[].timeframe-recurrence-rrule`	string
`timeframe-days-of-week-array[].timeframe-is-v1`	boolean

Create a holidays time frame for a user

POST/domains/~/users/{user}/timeframes

Adds a holidays time frame for one user.

Write Key Admin switch: Schedules (time frames), Write.

Parameters

Name	In	Type	Notes
`user` required	path	string	The user ID, usually their extension number, like `1001`. Default `~` Min length 0 Max length 16

Request body application/json

Field	Type	Notes
`synchronous` required	string	Set to `yes` to wait until the change is finished before the response comes back. One of: `yes`, `no` Default `no`
`timeframe-name`	string	Name of the time frame.
`timeframe-type`	string	What kind of time frame it is.
`timeframe-holiday-array`	array of object
`timeframe-holiday-array[].timeframe-id`	string	The time frame's ID.
`timeframe-holiday-array[].timeframe-parent-id`	string	ID of the timeframe parent.
`timeframe-holiday-array[].ordinal-order`	number
`timeframe-holiday-array[].timeframe-holiday-uuid` required	string
`timeframe-holiday-array[].timeframe-holiday-name` required	string	Name of the timeframe holiday.
`timeframe-holiday-array[].timeframe-holiday-begin-date` required	string	Timeframe holiday begin (date).
`timeframe-holiday-array[].country-abbreviation` required	string
`timeframe-holiday-array[].state-province-abbreviation` required	string
`timeframe-holiday-array[].holiday-api-location-hint` required	string
`timeframe-holiday-array[].timeframe-holiday-begin-time-1` required	string
`timeframe-holiday-array[].timeframe-holiday-end-time-1` required	string
`timeframe-holiday-array[].timeframe-holiday-begin-time-2` required	string
`timeframe-holiday-array[].timeframe-holiday-end-time-2` required	string
`timeframe-holiday-array[].timeframe-weekly-monday-observance-option` required	string
`timeframe-holiday-array[].timeframe-weekly-tuesday-observance-option` required	string
`timeframe-holiday-array[].timeframe-weekly-wednesday-observance-option` required	string
`timeframe-holiday-array[].timeframe-weekly-thursday-observance-option` required	string
`timeframe-holiday-array[].timeframe-weekly-friday-observance-option` required	string
`timeframe-holiday-array[].timeframe-weekly-saturday-observance-option` required	string
`timeframe-holiday-array[].timeframe-weekly-sunday-observance-option` required	string
`timeframe-holiday-array[].timeframe-workweek-list` required	string
`timeframe-holiday-array[].timeframe-recurrence-type` required	string
`timeframe-holiday-array[].timeframe-recurrence-end-option` required	string
`timeframe-holiday-array[].timeframe-recurrence-end-date` required	string	Timeframe recurrence end (date).
`timeframe-holiday-array[].timeframe-expiry-datetime`	string	Timeframe expiry (date and time).
`timeframe-holiday-array[].domain`	string	The account the item belongs to.
`timeframe-holiday-array[].timeframe-next-observance-datetime`	array of number	Timeframe next observance (date and time).

Example request

curl -X POST "https://api.noodlevoice.com/ns-api/v2/domains/~/users/1001/timeframes" \
  -H "Authorization: Bearer $NOODLEVOICE_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "synchronous": "yes"
  }'

const res = await fetch("https://api.noodlevoice.com/ns-api/v2/domains/~/users/1001/timeframes", {
  method: "POST",
  headers: {
    Authorization: "Bearer " + process.env.NOODLEVOICE_KEY,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "synchronous": "yes"
  }),
});
const data = await res.json();

import os, requests

r = requests.post(
    "https://api.noodlevoice.com/ns-api/v2/domains/~/users/1001/timeframes",
    headers={"Authorization": "Bearer " + os.environ["NOODLEVOICE_KEY"]},
    json={
        "synchronous": "yes"
    },
)
print(r.status_code, r.json())

Response 200

{
  "timeframe-id": "string",
  "timeframe-name": "Front Desk",
  "user": "1001",
  "domain": "string",
  "timeframe-type": "string",
  "timeframe-specific-dates-array": [
    {}
  ],
  "timeframe-holiday-array": [
    {}
  ],
  "timeframe-days-of-week-array": [
    {}
  ]
}

Response fields (96)

Field	Type	Notes
`timeframe-id`	string	The time frame's ID.
`timeframe-name`	string	Name of the time frame.
`user`	string	The user ID (extension).
`domain`	string	The account the item belongs to.
`timeframe-type`	string	What kind of time frame it is.
`timeframe-specific-dates-array`	array of object
`timeframe-specific-dates-array[].timeframe-id`	string	The time frame's ID.
`timeframe-specific-dates-array[].timeframe-parent-id`	string	ID of the timeframe parent.
`timeframe-specific-dates-array[].ordinal-order`	number
`timeframe-specific-dates-array[].timeframe-specific-dates-begin-date`	string	Timeframe specific dates begin (date).
`timeframe-specific-dates-array[].timeframe-specific-dates-begin-time`	string
`timeframe-specific-dates-array[].timeframe-specific-dates-end-date`	string	Timeframe specific dates end (date).
`timeframe-specific-dates-array[].timeframe-specific-dates-end-time`	string
`timeframe-specific-dates-array[].timeframe-recurrence-type`	string
`timeframe-specific-dates-array[].timeframe-recurrence-custom-interval`	string
`timeframe-specific-dates-array[].timeframe-recurrence-custom-interval-count`	string	Number of timeframe recurrence custom interval.
`timeframe-specific-dates-array[].timeframe-recurrence-custom-interval-option`	string
`timeframe-specific-dates-array[].timeframe-recurrence-end-option`	string
`timeframe-specific-dates-array[].timeframe-recurrence-end-date`	string	Timeframe recurrence end (date).
`timeframe-specific-dates-array[].timeframe-expiry-datetime`	string	Timeframe expiry (date and time).
`timeframe-specific-dates-array[].domain`	string	The account the item belongs to.
`timeframe-specific-dates-array[].timeframe-recurrence-rrule`	string
`timeframe-specific-dates-array[].timeframe-next-observance-datetime`	array of number	Timeframe next observance (date and time).
`timeframe-specific-dates-array[].timeframe-is-v1`	boolean
`timeframe-holiday-array`	array of object
`timeframe-holiday-array[].timeframe-id`	string	The time frame's ID.
`timeframe-holiday-array[].timeframe-parent-id`	string	ID of the timeframe parent.
`timeframe-holiday-array[].ordinal-order`	number
`timeframe-holiday-array[].timeframe-holiday-uuid`	string
`timeframe-holiday-array[].timeframe-holiday-name`	string	Name of the timeframe holiday.
`timeframe-holiday-array[].timeframe-holiday-begin-date`	string	Timeframe holiday begin (date).
`timeframe-holiday-array[].country-abbreviation`	string
`timeframe-holiday-array[].state-province-abbreviation`	string
`timeframe-holiday-array[].holiday-api-location-hint`	string
`timeframe-holiday-array[].timeframe-holiday-begin-time-1`	string
`timeframe-holiday-array[].timeframe-holiday-end-time-1`	string
`timeframe-holiday-array[].timeframe-holiday-begin-time-2`	string
`timeframe-holiday-array[].timeframe-holiday-end-time-2`	string
`timeframe-holiday-array[].timeframe-weekly-monday-observance-option`	string
`timeframe-holiday-array[].timeframe-weekly-tuesday-observance-option`	string
`timeframe-holiday-array[].timeframe-weekly-wednesday-observance-option`	string
`timeframe-holiday-array[].timeframe-weekly-thursday-observance-option`	string
`timeframe-holiday-array[].timeframe-weekly-friday-observance-option`	string
`timeframe-holiday-array[].timeframe-weekly-saturday-observance-option`	string
`timeframe-holiday-array[].timeframe-weekly-sunday-observance-option`	string
`timeframe-holiday-array[].timeframe-workweek-list`	string
`timeframe-holiday-array[].timeframe-recurrence-type`	string
`timeframe-holiday-array[].timeframe-recurrence-end-option`	string
`timeframe-holiday-array[].timeframe-recurrence-end-date`	string	Timeframe recurrence end (date).
`timeframe-holiday-array[].timeframe-expiry-datetime`	string	Timeframe expiry (date and time).
`timeframe-holiday-array[].domain`	string	The account the item belongs to.
`timeframe-holiday-array[].timeframe-next-observance-datetime`	array of number	Timeframe next observance (date and time).
`timeframe-days-of-week-array`	array of object
`timeframe-days-of-week-array[].timeframe-id`	string	The time frame's ID.
`timeframe-days-of-week-array[].timeframe-parent-id`	string	ID of the timeframe parent.
`timeframe-days-of-week-array[].ordinal-order`	number
`timeframe-days-of-week-array[].timeframe-weekly-sunday-begin-time-1`	string
`timeframe-days-of-week-array[].timeframe-weekly-sunday-end-time-1`	string
`timeframe-days-of-week-array[].timeframe-weekly-sunday-begin-time-2`	string
`timeframe-days-of-week-array[].timeframe-weekly-sunday-end-time-2`	string
`timeframe-days-of-week-array[].timeframe-weekly-monday-begin-time-1`	string
`timeframe-days-of-week-array[].timeframe-weekly-monday-end-time-1`	string
`timeframe-days-of-week-array[].timeframe-weekly-monday-begin-time-2`	string
`timeframe-days-of-week-array[].timeframe-weekly-monday-end-time-2`	string
`timeframe-days-of-week-array[].timeframe-weekly-tuesday-begin-time-1`	string
`timeframe-days-of-week-array[].timeframe-weekly-tuesday-end-time-1`	string
`timeframe-days-of-week-array[].timeframe-weekly-tuesday-begin-time-2`	string
`timeframe-days-of-week-array[].timeframe-weekly-tuesday-end-time-2`	string
`timeframe-days-of-week-array[].timeframe-weekly-wednesday-begin-time-1`	string
`timeframe-days-of-week-array[].timeframe-weekly-wednesday-end-time-1`	string
`timeframe-days-of-week-array[].timeframe-weekly-wednesday-begin-time-2`	string
`timeframe-days-of-week-array[].timeframe-weekly-wednesday-end-time-2`	string
`timeframe-days-of-week-array[].timeframe-weekly-thursday-begin-time-1`	string
`timeframe-days-of-week-array[].timeframe-weekly-thursday-end-time-1`	string
`timeframe-days-of-week-array[].timeframe-weekly-thursday-begin-time-2`	string
`timeframe-days-of-week-array[].timeframe-weekly-thursday-end-time-2`	string
`timeframe-days-of-week-array[].timeframe-weekly-friday-begin-time-1`	string
`timeframe-days-of-week-array[].timeframe-weekly-friday-end-time-1`	string
`timeframe-days-of-week-array[].timeframe-weekly-friday-begin-time-2`	string
`timeframe-days-of-week-array[].timeframe-weekly-friday-end-time-2`	string
`timeframe-days-of-week-array[].timeframe-weekly-saturday-begin-time-1`	string
`timeframe-days-of-week-array[].timeframe-weekly-saturday-end-time-1`	string
`timeframe-days-of-week-array[].timeframe-weekly-saturday-begin-time-2`	string
`timeframe-days-of-week-array[].timeframe-weekly-saturday-end-time-2`	string
`timeframe-days-of-week-array[].timeframe-recurrence-type`	string
`timeframe-days-of-week-array[].timeframe-recurrence-begin-date`	string	Timeframe recurrence begin (date).
`timeframe-days-of-week-array[].timeframe-recurrence-custom-interval`	string
`timeframe-days-of-week-array[].timeframe-recurrence-custom-interval-count`	string	Number of timeframe recurrence custom interval.
`timeframe-days-of-week-array[].timeframe-recurrence-custom-interval-option`	string
`timeframe-days-of-week-array[].timeframe-recurrence-end-option`	string
`timeframe-days-of-week-array[].timeframe-recurrence-end-date`	string	Timeframe recurrence end (date).
`timeframe-days-of-week-array[].timeframe-expiry-datetime`	string	Timeframe expiry (date and time).
`timeframe-days-of-week-array[].domain`	string	The account the item belongs to.
`timeframe-days-of-week-array[].timeframe-next-observance-datetime`	array of number	Timeframe next observance (date and time).
`timeframe-days-of-week-array[].timeframe-recurrence-rrule`	string
`timeframe-days-of-week-array[].timeframe-is-v1`	boolean

Create a custom time frame for a user

POST/domains/~/users/{user}/timeframes

Adds a time frame for one user that mixes date ranges, weekly hours and holidays.

Write Key Admin switch: Schedules (time frames), Write.

Parameters

Name	In	Type	Notes
`user` required	path	string	The user ID, usually their extension number, like `1001`. Default `~` Min length 0 Max length 16

Request body application/json

Field	Type	Notes
`synchronous` required	string	Set to `yes` to wait until the change is finished before the response comes back. One of: `yes`, `no` Default `no`
`timeframe-name`	string	Name of the time frame.
`timeframe-type`	string	What kind of time frame it is.
`timeframe-specific-dates-array`	array of object
`timeframe-specific-dates-array[].timeframe-id`	string	The time frame's ID.
`timeframe-specific-dates-array[].timeframe-parent-id`	string	ID of the timeframe parent.
`timeframe-specific-dates-array[].ordinal-order`	number
`timeframe-specific-dates-array[].timeframe-specific-dates-begin-date` required	string	Timeframe specific dates begin (date).
`timeframe-specific-dates-array[].timeframe-specific-dates-begin-time` required	string
`timeframe-specific-dates-array[].timeframe-specific-dates-end-date` required	string	Timeframe specific dates end (date).
`timeframe-specific-dates-array[].timeframe-specific-dates-end-time` required	string
`timeframe-specific-dates-array[].timeframe-recurrence-type` required	string
`timeframe-specific-dates-array[].timeframe-recurrence-custom-interval` required	string
`timeframe-specific-dates-array[].timeframe-recurrence-custom-interval-count` required	string	Number of timeframe recurrence custom interval.
`timeframe-specific-dates-array[].timeframe-recurrence-custom-interval-option` required	string
`timeframe-specific-dates-array[].timeframe-recurrence-end-option` required	string
`timeframe-specific-dates-array[].timeframe-recurrence-end-date` required	string	Timeframe recurrence end (date).
`timeframe-specific-dates-array[].timeframe-expiry-datetime`	string	Timeframe expiry (date and time).
`timeframe-specific-dates-array[].domain`	string	The account the item belongs to.
`timeframe-specific-dates-array[].timeframe-recurrence-rrule`	string
`timeframe-specific-dates-array[].timeframe-next-observance-datetime`	array of number	Timeframe next observance (date and time).
`timeframe-specific-dates-array[].timeframe-is-v1`	boolean
`timeframe-holiday-array`	array of object
`timeframe-holiday-array[].timeframe-id`	string	The time frame's ID.
`timeframe-holiday-array[].timeframe-parent-id`	string	ID of the timeframe parent.
`timeframe-holiday-array[].ordinal-order`	number
`timeframe-holiday-array[].timeframe-holiday-uuid` required	string
`timeframe-holiday-array[].timeframe-holiday-name` required	string	Name of the timeframe holiday.
`timeframe-holiday-array[].timeframe-holiday-begin-date` required	string	Timeframe holiday begin (date).
`timeframe-holiday-array[].country-abbreviation` required	string
`timeframe-holiday-array[].state-province-abbreviation` required	string
`timeframe-holiday-array[].holiday-api-location-hint` required	string
`timeframe-holiday-array[].timeframe-holiday-begin-time-1` required	string
`timeframe-holiday-array[].timeframe-holiday-end-time-1` required	string
`timeframe-holiday-array[].timeframe-holiday-begin-time-2` required	string
`timeframe-holiday-array[].timeframe-holiday-end-time-2` required	string
`timeframe-holiday-array[].timeframe-weekly-monday-observance-option` required	string
`timeframe-holiday-array[].timeframe-weekly-tuesday-observance-option` required	string
`timeframe-holiday-array[].timeframe-weekly-wednesday-observance-option` required	string
`timeframe-holiday-array[].timeframe-weekly-thursday-observance-option` required	string
`timeframe-holiday-array[].timeframe-weekly-friday-observance-option` required	string
`timeframe-holiday-array[].timeframe-weekly-saturday-observance-option` required	string
`timeframe-holiday-array[].timeframe-weekly-sunday-observance-option` required	string
`timeframe-holiday-array[].timeframe-workweek-list` required	string
`timeframe-holiday-array[].timeframe-recurrence-type` required	string
`timeframe-holiday-array[].timeframe-recurrence-end-option` required	string
`timeframe-holiday-array[].timeframe-recurrence-end-date` required	string	Timeframe recurrence end (date).
`timeframe-holiday-array[].timeframe-expiry-datetime`	string	Timeframe expiry (date and time).
`timeframe-holiday-array[].domain`	string	The account the item belongs to.
`timeframe-holiday-array[].timeframe-next-observance-datetime`	array of number	Timeframe next observance (date and time).
`timeframe-days-of-week-array`	array of object
`timeframe-days-of-week-array[].timeframe-id`	string	The time frame's ID.
`timeframe-days-of-week-array[].timeframe-parent-id`	string	ID of the timeframe parent.
`timeframe-days-of-week-array[].ordinal-order`	number
`timeframe-days-of-week-array[].timeframe-weekly-sunday-begin-time-1`	string
`timeframe-days-of-week-array[].timeframe-weekly-sunday-end-time-1`	string
`timeframe-days-of-week-array[].timeframe-weekly-sunday-begin-time-2`	string
`timeframe-days-of-week-array[].timeframe-weekly-sunday-end-time-2`	string
`timeframe-days-of-week-array[].timeframe-weekly-monday-begin-time-1`	string
`timeframe-days-of-week-array[].timeframe-weekly-monday-end-time-1`	string
`timeframe-days-of-week-array[].timeframe-weekly-monday-begin-time-2`	string
`timeframe-days-of-week-array[].timeframe-weekly-monday-end-time-2`	string
`timeframe-days-of-week-array[].timeframe-weekly-tuesday-begin-time-1`	string
`timeframe-days-of-week-array[].timeframe-weekly-tuesday-end-time-1`	string
`timeframe-days-of-week-array[].timeframe-weekly-tuesday-begin-time-2`	string
`timeframe-days-of-week-array[].timeframe-weekly-tuesday-end-time-2`	string
`timeframe-days-of-week-array[].timeframe-weekly-wednesday-begin-time-1`	string
`timeframe-days-of-week-array[].timeframe-weekly-wednesday-end-time-1`	string
`timeframe-days-of-week-array[].timeframe-weekly-wednesday-begin-time-2`	string
`timeframe-days-of-week-array[].timeframe-weekly-wednesday-end-time-2`	string
`timeframe-days-of-week-array[].timeframe-weekly-thursday-begin-time-1`	string
`timeframe-days-of-week-array[].timeframe-weekly-thursday-end-time-1`	string
`timeframe-days-of-week-array[].timeframe-weekly-thursday-begin-time-2`	string
`timeframe-days-of-week-array[].timeframe-weekly-thursday-end-time-2`	string
`timeframe-days-of-week-array[].timeframe-weekly-friday-begin-time-1`	string
`timeframe-days-of-week-array[].timeframe-weekly-friday-end-time-1`	string
`timeframe-days-of-week-array[].timeframe-weekly-friday-begin-time-2`	string
`timeframe-days-of-week-array[].timeframe-weekly-friday-end-time-2`	string
`timeframe-days-of-week-array[].timeframe-weekly-saturday-begin-time-1`	string
`timeframe-days-of-week-array[].timeframe-weekly-saturday-end-time-1`	string
`timeframe-days-of-week-array[].timeframe-weekly-saturday-begin-time-2`	string
`timeframe-days-of-week-array[].timeframe-weekly-saturday-end-time-2`	string
`timeframe-days-of-week-array[].timeframe-recurrence-type` required	string
`timeframe-days-of-week-array[].timeframe-recurrence-begin-date` required	string	Timeframe recurrence begin (date).
`timeframe-days-of-week-array[].timeframe-recurrence-custom-interval` required	string
`timeframe-days-of-week-array[].timeframe-recurrence-custom-interval-count` required	string	Number of timeframe recurrence custom interval.
`timeframe-days-of-week-array[].timeframe-recurrence-custom-interval-option` required	string
`timeframe-days-of-week-array[].timeframe-recurrence-end-option` required	string
`timeframe-days-of-week-array[].timeframe-recurrence-end-date` required	string	Timeframe recurrence end (date).
`timeframe-days-of-week-array[].timeframe-expiry-datetime`	string	Timeframe expiry (date and time).
`timeframe-days-of-week-array[].domain`	string	The account the item belongs to.
`timeframe-days-of-week-array[].timeframe-next-observance-datetime`	array of number	Timeframe next observance (date and time).
`timeframe-days-of-week-array[].timeframe-recurrence-rrule`	string
`timeframe-days-of-week-array[].timeframe-is-v1`	boolean

Example request

curl -X POST "https://api.noodlevoice.com/ns-api/v2/domains/~/users/1001/timeframes" \
  -H "Authorization: Bearer $NOODLEVOICE_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "synchronous": "yes"
  }'

const res = await fetch("https://api.noodlevoice.com/ns-api/v2/domains/~/users/1001/timeframes", {
  method: "POST",
  headers: {
    Authorization: "Bearer " + process.env.NOODLEVOICE_KEY,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "synchronous": "yes"
  }),
});
const data = await res.json();

import os, requests

r = requests.post(
    "https://api.noodlevoice.com/ns-api/v2/domains/~/users/1001/timeframes",
    headers={"Authorization": "Bearer " + os.environ["NOODLEVOICE_KEY"]},
    json={
        "synchronous": "yes"
    },
)
print(r.status_code, r.json())

Response 200

Returns a status code with a short JSON message.

Create an always time frame for a user

POST/domains/~/users/{user}/timeframes

Adds a time frame for one user that is always active.

Write Key Admin switch: Schedules (time frames), Write.

Parameters

Name	In	Type	Notes
`user` required	path	string	The user ID, usually their extension number, like `1001`. Default `~` Min length 0 Max length 16

Request body application/json

Field	Type	Notes
`synchronous` required	string	Set to `yes` to wait until the change is finished before the response comes back. One of: `yes`, `no` Default `no`
`timeframe-name`	string	Name of the time frame.
`timeframe-type`	string	What kind of time frame it is.

Example request

curl -X POST "https://api.noodlevoice.com/ns-api/v2/domains/~/users/1001/timeframes" \
  -H "Authorization: Bearer $NOODLEVOICE_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "synchronous": "yes"
  }'

const res = await fetch("https://api.noodlevoice.com/ns-api/v2/domains/~/users/1001/timeframes", {
  method: "POST",
  headers: {
    Authorization: "Bearer " + process.env.NOODLEVOICE_KEY,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "synchronous": "yes"
  }),
});
const data = await res.json();

import os, requests

r = requests.post(
    "https://api.noodlevoice.com/ns-api/v2/domains/~/users/1001/timeframes",
    headers={"Authorization": "Bearer " + os.environ["NOODLEVOICE_KEY"]},
    json={
        "synchronous": "yes"
    },
)
print(r.status_code, r.json())

Response 200

Returns a status code with a short JSON message.

Other responses: 400, 401, 404. See errors.

Add holidays to a user's time frame

POST/domains/~/users/{user}/timeframes/{id}

Adds more holidays to one of a user's holidays time frames.

Write Key Admin switch: Schedules (time frames), Write.

Parameters

Name	In	Type	Notes
`user` required	path	string	The user ID, usually their extension number, like `1001`. Default `~` Min length 0 Max length 16
`id` required	path	string	The ID of the item, as returned when you list or create it.

Request body application/json

Field	Type	Notes
`timeframe-holiday-array`	array of object
`timeframe-holiday-array[].timeframe-id`	string	The time frame's ID.
`timeframe-holiday-array[].timeframe-parent-id`	string	ID of the timeframe parent.
`timeframe-holiday-array[].ordinal-order`	number
`timeframe-holiday-array[].timeframe-holiday-uuid` required	string
`timeframe-holiday-array[].timeframe-holiday-name` required	string	Name of the timeframe holiday.
`timeframe-holiday-array[].timeframe-holiday-begin-date` required	string	Timeframe holiday begin (date).
`timeframe-holiday-array[].country-abbreviation` required	string
`timeframe-holiday-array[].state-province-abbreviation` required	string
`timeframe-holiday-array[].holiday-api-location-hint` required	string
`timeframe-holiday-array[].timeframe-holiday-begin-time-1` required	string
`timeframe-holiday-array[].timeframe-holiday-end-time-1` required	string
`timeframe-holiday-array[].timeframe-holiday-begin-time-2` required	string
`timeframe-holiday-array[].timeframe-holiday-end-time-2` required	string
`timeframe-holiday-array[].timeframe-weekly-monday-observance-option` required	string
`timeframe-holiday-array[].timeframe-weekly-tuesday-observance-option` required	string
`timeframe-holiday-array[].timeframe-weekly-wednesday-observance-option` required	string
`timeframe-holiday-array[].timeframe-weekly-thursday-observance-option` required	string
`timeframe-holiday-array[].timeframe-weekly-friday-observance-option` required	string
`timeframe-holiday-array[].timeframe-weekly-saturday-observance-option` required	string
`timeframe-holiday-array[].timeframe-weekly-sunday-observance-option` required	string
`timeframe-holiday-array[].timeframe-workweek-list` required	string
`timeframe-holiday-array[].timeframe-recurrence-type` required	string
`timeframe-holiday-array[].timeframe-recurrence-end-option` required	string
`timeframe-holiday-array[].timeframe-recurrence-end-date` required	string	Timeframe recurrence end (date).
`timeframe-holiday-array[].timeframe-expiry-datetime`	string	Timeframe expiry (date and time).
`timeframe-holiday-array[].domain`	string	The account the item belongs to.
`timeframe-holiday-array[].timeframe-next-observance-datetime`	array of number	Timeframe next observance (date and time).

Example request

curl -X POST "https://api.noodlevoice.com/ns-api/v2/domains/~/users/1001/timeframes/{id}" \
  -H "Authorization: Bearer $NOODLEVOICE_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "timeframe-holiday-array": [
      {
        "timeframe-holiday-uuid": "string",
        "timeframe-holiday-name": "Front Desk",
        "timeframe-holiday-begin-date": "2026-11-02",
        "country-abbreviation": "string",
        "state-province-abbreviation": "string",
        "holiday-api-location-hint": "string",
        "timeframe-holiday-begin-time-1": "string",
        "timeframe-holiday-end-time-1": "string",
        "timeframe-holiday-begin-time-2": "string",
        "timeframe-holiday-end-time-2": "string",
        "timeframe-weekly-monday-observance-option": "string",
        "timeframe-weekly-tuesday-observance-option": "string",
        "timeframe-weekly-wednesday-observance-option": "string",
        "timeframe-weekly-thursday-observance-option": "string",
        "timeframe-weekly-friday-observance-option": "string",
        "timeframe-weekly-saturday-observance-option": "string",
        "timeframe-weekly-sunday-observance-option": "string",
        "timeframe-workweek-list": "string",
        "timeframe-recurrence-type": "string",
        "timeframe-recurrence-end-option": "string",
        "timeframe-recurrence-end-date": "2026-11-02"
      }
    ]
  }'

const res = await fetch("https://api.noodlevoice.com/ns-api/v2/domains/~/users/1001/timeframes/{id}", {
  method: "POST",
  headers: {
    Authorization: "Bearer " + process.env.NOODLEVOICE_KEY,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "timeframe-holiday-array": [
      {
        "timeframe-holiday-uuid": "string",
        "timeframe-holiday-name": "Front Desk",
        "timeframe-holiday-begin-date": "2026-11-02",
        "country-abbreviation": "string",
        "state-province-abbreviation": "string",
        "holiday-api-location-hint": "string",
        "timeframe-holiday-begin-time-1": "string",
        "timeframe-holiday-end-time-1": "string",
        "timeframe-holiday-begin-time-2": "string",
        "timeframe-holiday-end-time-2": "string",
        "timeframe-weekly-monday-observance-option": "string",
        "timeframe-weekly-tuesday-observance-option": "string",
        "timeframe-weekly-wednesday-observance-option": "string",
        "timeframe-weekly-thursday-observance-option": "string",
        "timeframe-weekly-friday-observance-option": "string",
        "timeframe-weekly-saturday-observance-option": "string",
        "timeframe-weekly-sunday-observance-option": "string",
        "timeframe-workweek-list": "string",
        "timeframe-recurrence-type": "string",
        "timeframe-recurrence-end-option": "string",
        "timeframe-recurrence-end-date": "2026-11-02"
      }
    ]
  }),
});
const data = await res.json();

import os, requests

r = requests.post(
    "https://api.noodlevoice.com/ns-api/v2/domains/~/users/1001/timeframes/{id}",
    headers={"Authorization": "Bearer " + os.environ["NOODLEVOICE_KEY"]},
    json={
        "timeframe-holiday-array": [
            {
                "timeframe-holiday-uuid": "string",
                "timeframe-holiday-name": "Front Desk",
                "timeframe-holiday-begin-date": "2026-11-02",
                "country-abbreviation": "string",
                "state-province-abbreviation": "string",
                "holiday-api-location-hint": "string",
                "timeframe-holiday-begin-time-1": "string",
                "timeframe-holiday-end-time-1": "string",
                "timeframe-holiday-begin-time-2": "string",
                "timeframe-holiday-end-time-2": "string",
                "timeframe-weekly-monday-observance-option": "string",
                "timeframe-weekly-tuesday-observance-option": "string",
                "timeframe-weekly-wednesday-observance-option": "string",
                "timeframe-weekly-thursday-observance-option": "string",
                "timeframe-weekly-friday-observance-option": "string",
                "timeframe-weekly-saturday-observance-option": "string",
                "timeframe-weekly-sunday-observance-option": "string",
                "timeframe-workweek-list": "string",
                "timeframe-recurrence-type": "string",
                "timeframe-recurrence-end-option": "string",
                "timeframe-recurrence-end-date": "2026-11-02"
            }
        ]
    },
)
print(r.status_code, r.json())

Response 202

Returns a status code with a short JSON message.

Other responses: 400, 401, 404. See errors.

Add entries to a user's custom time frame

POST/domains/~/users/{user}/timeframes/{id}

Adds more entries to one of a user's custom time frames.

Write Key Admin switch: Schedules (time frames), Write.

Parameters

Name	In	Type	Notes
`user` required	path	string	The user ID, usually their extension number, like `1001`. Default `~` Min length 0 Max length 16
`id` required	path	string	The ID of the item, as returned when you list or create it.

Request body application/json

Field	Type	Notes
`timeframe-specific-dates-array`	array of object
`timeframe-specific-dates-array[].timeframe-id`	string	The time frame's ID.
`timeframe-specific-dates-array[].timeframe-parent-id`	string	ID of the timeframe parent.
`timeframe-specific-dates-array[].ordinal-order`	number
`timeframe-specific-dates-array[].timeframe-specific-dates-begin-date` required	string	Timeframe specific dates begin (date).
`timeframe-specific-dates-array[].timeframe-specific-dates-begin-time` required	string
`timeframe-specific-dates-array[].timeframe-specific-dates-end-date` required	string	Timeframe specific dates end (date).
`timeframe-specific-dates-array[].timeframe-specific-dates-end-time` required	string
`timeframe-specific-dates-array[].timeframe-recurrence-type` required	string
`timeframe-specific-dates-array[].timeframe-recurrence-custom-interval` required	string
`timeframe-specific-dates-array[].timeframe-recurrence-custom-interval-count` required	string	Number of timeframe recurrence custom interval.
`timeframe-specific-dates-array[].timeframe-recurrence-custom-interval-option` required	string
`timeframe-specific-dates-array[].timeframe-recurrence-end-option` required	string
`timeframe-specific-dates-array[].timeframe-recurrence-end-date` required	string	Timeframe recurrence end (date).
`timeframe-specific-dates-array[].timeframe-expiry-datetime`	string	Timeframe expiry (date and time).
`timeframe-specific-dates-array[].domain`	string	The account the item belongs to.
`timeframe-specific-dates-array[].timeframe-recurrence-rrule`	string
`timeframe-specific-dates-array[].timeframe-next-observance-datetime`	array of number	Timeframe next observance (date and time).
`timeframe-specific-dates-array[].timeframe-is-v1`	boolean
`timeframe-holiday-array`	array of object
`timeframe-holiday-array[].timeframe-id`	string	The time frame's ID.
`timeframe-holiday-array[].timeframe-parent-id`	string	ID of the timeframe parent.
`timeframe-holiday-array[].ordinal-order`	number
`timeframe-holiday-array[].timeframe-holiday-uuid` required	string
`timeframe-holiday-array[].timeframe-holiday-name` required	string	Name of the timeframe holiday.
`timeframe-holiday-array[].timeframe-holiday-begin-date` required	string	Timeframe holiday begin (date).
`timeframe-holiday-array[].country-abbreviation` required	string
`timeframe-holiday-array[].state-province-abbreviation` required	string
`timeframe-holiday-array[].holiday-api-location-hint` required	string
`timeframe-holiday-array[].timeframe-holiday-begin-time-1` required	string
`timeframe-holiday-array[].timeframe-holiday-end-time-1` required	string
`timeframe-holiday-array[].timeframe-holiday-begin-time-2` required	string
`timeframe-holiday-array[].timeframe-holiday-end-time-2` required	string
`timeframe-holiday-array[].timeframe-weekly-monday-observance-option` required	string
`timeframe-holiday-array[].timeframe-weekly-tuesday-observance-option` required	string
`timeframe-holiday-array[].timeframe-weekly-wednesday-observance-option` required	string
`timeframe-holiday-array[].timeframe-weekly-thursday-observance-option` required	string
`timeframe-holiday-array[].timeframe-weekly-friday-observance-option` required	string
`timeframe-holiday-array[].timeframe-weekly-saturday-observance-option` required	string
`timeframe-holiday-array[].timeframe-weekly-sunday-observance-option` required	string
`timeframe-holiday-array[].timeframe-workweek-list` required	string
`timeframe-holiday-array[].timeframe-recurrence-type` required	string
`timeframe-holiday-array[].timeframe-recurrence-end-option` required	string
`timeframe-holiday-array[].timeframe-recurrence-end-date` required	string	Timeframe recurrence end (date).
`timeframe-holiday-array[].timeframe-expiry-datetime`	string	Timeframe expiry (date and time).
`timeframe-holiday-array[].domain`	string	The account the item belongs to.
`timeframe-holiday-array[].timeframe-next-observance-datetime`	array of number	Timeframe next observance (date and time).
`timeframe-days-of-week-array`	array of object
`timeframe-days-of-week-array[].timeframe-id`	string	The time frame's ID.
`timeframe-days-of-week-array[].timeframe-parent-id`	string	ID of the timeframe parent.
`timeframe-days-of-week-array[].ordinal-order`	number
`timeframe-days-of-week-array[].timeframe-weekly-sunday-begin-time-1`	string
`timeframe-days-of-week-array[].timeframe-weekly-sunday-end-time-1`	string
`timeframe-days-of-week-array[].timeframe-weekly-sunday-begin-time-2`	string
`timeframe-days-of-week-array[].timeframe-weekly-sunday-end-time-2`	string
`timeframe-days-of-week-array[].timeframe-weekly-monday-begin-time-1`	string
`timeframe-days-of-week-array[].timeframe-weekly-monday-end-time-1`	string
`timeframe-days-of-week-array[].timeframe-weekly-monday-begin-time-2`	string
`timeframe-days-of-week-array[].timeframe-weekly-monday-end-time-2`	string
`timeframe-days-of-week-array[].timeframe-weekly-tuesday-begin-time-1`	string
`timeframe-days-of-week-array[].timeframe-weekly-tuesday-end-time-1`	string
`timeframe-days-of-week-array[].timeframe-weekly-tuesday-begin-time-2`	string
`timeframe-days-of-week-array[].timeframe-weekly-tuesday-end-time-2`	string
`timeframe-days-of-week-array[].timeframe-weekly-wednesday-begin-time-1`	string
`timeframe-days-of-week-array[].timeframe-weekly-wednesday-end-time-1`	string
`timeframe-days-of-week-array[].timeframe-weekly-wednesday-begin-time-2`	string
`timeframe-days-of-week-array[].timeframe-weekly-wednesday-end-time-2`	string
`timeframe-days-of-week-array[].timeframe-weekly-thursday-begin-time-1`	string
`timeframe-days-of-week-array[].timeframe-weekly-thursday-end-time-1`	string
`timeframe-days-of-week-array[].timeframe-weekly-thursday-begin-time-2`	string
`timeframe-days-of-week-array[].timeframe-weekly-thursday-end-time-2`	string
`timeframe-days-of-week-array[].timeframe-weekly-friday-begin-time-1`	string
`timeframe-days-of-week-array[].timeframe-weekly-friday-end-time-1`	string
`timeframe-days-of-week-array[].timeframe-weekly-friday-begin-time-2`	string
`timeframe-days-of-week-array[].timeframe-weekly-friday-end-time-2`	string
`timeframe-days-of-week-array[].timeframe-weekly-saturday-begin-time-1`	string
`timeframe-days-of-week-array[].timeframe-weekly-saturday-end-time-1`	string
`timeframe-days-of-week-array[].timeframe-weekly-saturday-begin-time-2`	string
`timeframe-days-of-week-array[].timeframe-weekly-saturday-end-time-2`	string
`timeframe-days-of-week-array[].timeframe-recurrence-type` required	string
`timeframe-days-of-week-array[].timeframe-recurrence-begin-date` required	string	Timeframe recurrence begin (date).
`timeframe-days-of-week-array[].timeframe-recurrence-custom-interval` required	string
`timeframe-days-of-week-array[].timeframe-recurrence-custom-interval-count` required	string	Number of timeframe recurrence custom interval.
`timeframe-days-of-week-array[].timeframe-recurrence-custom-interval-option` required	string
`timeframe-days-of-week-array[].timeframe-recurrence-end-option` required	string
`timeframe-days-of-week-array[].timeframe-recurrence-end-date` required	string	Timeframe recurrence end (date).
`timeframe-days-of-week-array[].timeframe-expiry-datetime`	string	Timeframe expiry (date and time).
`timeframe-days-of-week-array[].domain`	string	The account the item belongs to.
`timeframe-days-of-week-array[].timeframe-next-observance-datetime`	array of number	Timeframe next observance (date and time).
`timeframe-days-of-week-array[].timeframe-recurrence-rrule`	string
`timeframe-days-of-week-array[].timeframe-is-v1`	boolean

Example request

curl -X POST "https://api.noodlevoice.com/ns-api/v2/domains/~/users/1001/timeframes/{id}" \
  -H "Authorization: Bearer $NOODLEVOICE_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "timeframe-specific-dates-array": [
      {
        "timeframe-specific-dates-begin-date": "2026-11-02",
        "timeframe-specific-dates-begin-time": "string",
        "timeframe-specific-dates-end-date": "2026-11-02",
        "timeframe-specific-dates-end-time": "string",
        "timeframe-recurrence-type": "string",
        "timeframe-recurrence-custom-interval-count": "string",
        "timeframe-recurrence-custom-interval": "string",
        "timeframe-recurrence-custom-interval-option": "string",
        "timeframe-recurrence-end-option": "string",
        "timeframe-recurrence-end-date": "2026-11-02"
      }
    ],
    "timeframe-holiday-array": [
      {
        "timeframe-holiday-uuid": "string",
        "timeframe-holiday-name": "Front Desk",
        "timeframe-holiday-begin-date": "2026-11-02",
        "country-abbreviation": "string",
        "state-province-abbreviation": "string",
        "holiday-api-location-hint": "string",
        "timeframe-holiday-begin-time-1": "string",
        "timeframe-holiday-end-time-1": "string",
        "timeframe-holiday-begin-time-2": "string",
        "timeframe-holiday-end-time-2": "string",
        "timeframe-weekly-monday-observance-option": "string",
        "timeframe-weekly-tuesday-observance-option": "string",
        "timeframe-weekly-wednesday-observance-option": "string",
        "timeframe-weekly-thursday-observance-option": "string",
        "timeframe-weekly-friday-observance-option": "string",
        "timeframe-weekly-saturday-observance-option": "string",
        "timeframe-weekly-sunday-observance-option": "string",
        "timeframe-workweek-list": "string",
        "timeframe-recurrence-type": "string",
        "timeframe-recurrence-end-option": "string",
        "timeframe-recurrence-end-date": "2026-11-02"
      }
    ],
    "timeframe-days-of-week-array": [
      {
        "timeframe-recurrence-begin-date": "2026-11-02",
        "timeframe-recurrence-type": "string",
        "timeframe-recurrence-custom-interval-count": "string",
        "timeframe-recurrence-custom-interval": "string",
        "timeframe-recurrence-custom-interval-option": "string",
        "timeframe-recurrence-end-option": "string",
        "timeframe-recurrence-end-date": "2026-11-02"
      }
    ]
  }'

const res = await fetch("https://api.noodlevoice.com/ns-api/v2/domains/~/users/1001/timeframes/{id}", {
  method: "POST",
  headers: {
    Authorization: "Bearer " + process.env.NOODLEVOICE_KEY,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "timeframe-specific-dates-array": [
      {
        "timeframe-specific-dates-begin-date": "2026-11-02",
        "timeframe-specific-dates-begin-time": "string",
        "timeframe-specific-dates-end-date": "2026-11-02",
        "timeframe-specific-dates-end-time": "string",
        "timeframe-recurrence-type": "string",
        "timeframe-recurrence-custom-interval-count": "string",
        "timeframe-recurrence-custom-interval": "string",
        "timeframe-recurrence-custom-interval-option": "string",
        "timeframe-recurrence-end-option": "string",
        "timeframe-recurrence-end-date": "2026-11-02"
      }
    ],
    "timeframe-holiday-array": [
      {
        "timeframe-holiday-uuid": "string",
        "timeframe-holiday-name": "Front Desk",
        "timeframe-holiday-begin-date": "2026-11-02",
        "country-abbreviation": "string",
        "state-province-abbreviation": "string",
        "holiday-api-location-hint": "string",
        "timeframe-holiday-begin-time-1": "string",
        "timeframe-holiday-end-time-1": "string",
        "timeframe-holiday-begin-time-2": "string",
        "timeframe-holiday-end-time-2": "string",
        "timeframe-weekly-monday-observance-option": "string",
        "timeframe-weekly-tuesday-observance-option": "string",
        "timeframe-weekly-wednesday-observance-option": "string",
        "timeframe-weekly-thursday-observance-option": "string",
        "timeframe-weekly-friday-observance-option": "string",
        "timeframe-weekly-saturday-observance-option": "string",
        "timeframe-weekly-sunday-observance-option": "string",
        "timeframe-workweek-list": "string",
        "timeframe-recurrence-type": "string",
        "timeframe-recurrence-end-option": "string",
        "timeframe-recurrence-end-date": "2026-11-02"
      }
    ],
    "timeframe-days-of-week-array": [
      {
        "timeframe-recurrence-begin-date": "2026-11-02",
        "timeframe-recurrence-type": "string",
        "timeframe-recurrence-custom-interval-count": "string",
        "timeframe-recurrence-custom-interval": "string",
        "timeframe-recurrence-custom-interval-option": "string",
        "timeframe-recurrence-end-option": "string",
        "timeframe-recurrence-end-date": "2026-11-02"
      }
    ]
  }),
});
const data = await res.json();

import os, requests

r = requests.post(
    "https://api.noodlevoice.com/ns-api/v2/domains/~/users/1001/timeframes/{id}",
    headers={"Authorization": "Bearer " + os.environ["NOODLEVOICE_KEY"]},
    json={
        "timeframe-specific-dates-array": [
            {
                "timeframe-specific-dates-begin-date": "2026-11-02",
                "timeframe-specific-dates-begin-time": "string",
                "timeframe-specific-dates-end-date": "2026-11-02",
                "timeframe-specific-dates-end-time": "string",
                "timeframe-recurrence-type": "string",
                "timeframe-recurrence-custom-interval-count": "string",
                "timeframe-recurrence-custom-interval": "string",
                "timeframe-recurrence-custom-interval-option": "string",
                "timeframe-recurrence-end-option": "string",
                "timeframe-recurrence-end-date": "2026-11-02"
            }
        ],
        "timeframe-holiday-array": [
            {
                "timeframe-holiday-uuid": "string",
                "timeframe-holiday-name": "Front Desk",
                "timeframe-holiday-begin-date": "2026-11-02",
                "country-abbreviation": "string",
                "state-province-abbreviation": "string",
                "holiday-api-location-hint": "string",
                "timeframe-holiday-begin-time-1": "string",
                "timeframe-holiday-end-time-1": "string",
                "timeframe-holiday-begin-time-2": "string",
                "timeframe-holiday-end-time-2": "string",
                "timeframe-weekly-monday-observance-option": "string",
                "timeframe-weekly-tuesday-observance-option": "string",
                "timeframe-weekly-wednesday-observance-option": "string",
                "timeframe-weekly-thursday-observance-option": "string",
                "timeframe-weekly-friday-observance-option": "string",
                "timeframe-weekly-saturday-observance-option": "string",
                "timeframe-weekly-sunday-observance-option": "string",
                "timeframe-workweek-list": "string",
                "timeframe-recurrence-type": "string",
                "timeframe-recurrence-end-option": "string",
                "timeframe-recurrence-end-date": "2026-11-02"
            }
        ],
        "timeframe-days-of-week-array": [
            {
                "timeframe-recurrence-begin-date": "2026-11-02",
                "timeframe-recurrence-type": "string",
                "timeframe-recurrence-custom-interval-count": "string",
                "timeframe-recurrence-custom-interval": "string",
                "timeframe-recurrence-custom-interval-option": "string",
                "timeframe-recurrence-end-option": "string",
                "timeframe-recurrence-end-date": "2026-11-02"
            }
        ]
    },
)
print(r.status_code, r.json())

Response 202

Returns a status code with a short JSON message.

Other responses: 400, 401, 404. See errors.

Add date ranges to a user's time frame

POST/domains/~/users/{user}/timeframes/{id}

Adds more date ranges to one of a user's specific dates time frames.

Write Key Admin switch: Schedules (time frames), Write.

Parameters

Name	In	Type	Notes
`user` required	path	string	The user ID, usually their extension number, like `1001`. Default `~` Min length 0 Max length 16
`id` required	path	string	The ID of the item, as returned when you list or create it.

Request body application/json

Field	Type	Notes
`timeframe-specific-dates-array`	array of object
`timeframe-specific-dates-array[].timeframe-id`	string	The time frame's ID.
`timeframe-specific-dates-array[].timeframe-parent-id`	string	ID of the timeframe parent.
`timeframe-specific-dates-array[].ordinal-order`	number
`timeframe-specific-dates-array[].timeframe-specific-dates-begin-date` required	string	Timeframe specific dates begin (date).
`timeframe-specific-dates-array[].timeframe-specific-dates-begin-time` required	string
`timeframe-specific-dates-array[].timeframe-specific-dates-end-date` required	string	Timeframe specific dates end (date).
`timeframe-specific-dates-array[].timeframe-specific-dates-end-time` required	string
`timeframe-specific-dates-array[].timeframe-recurrence-type` required	string
`timeframe-specific-dates-array[].timeframe-recurrence-custom-interval` required	string
`timeframe-specific-dates-array[].timeframe-recurrence-custom-interval-count` required	string	Number of timeframe recurrence custom interval.
`timeframe-specific-dates-array[].timeframe-recurrence-custom-interval-option` required	string
`timeframe-specific-dates-array[].timeframe-recurrence-end-option` required	string
`timeframe-specific-dates-array[].timeframe-recurrence-end-date` required	string	Timeframe recurrence end (date).
`timeframe-specific-dates-array[].timeframe-expiry-datetime`	string	Timeframe expiry (date and time).
`timeframe-specific-dates-array[].domain`	string	The account the item belongs to.
`timeframe-specific-dates-array[].timeframe-recurrence-rrule`	string
`timeframe-specific-dates-array[].timeframe-next-observance-datetime`	array of number	Timeframe next observance (date and time).
`timeframe-specific-dates-array[].timeframe-is-v1`	boolean
`timeframe-days-of-week-array`	array of object
`timeframe-days-of-week-array[].timeframe-id`	string	The time frame's ID.
`timeframe-days-of-week-array[].timeframe-parent-id`	string	ID of the timeframe parent.
`timeframe-days-of-week-array[].ordinal-order`	number
`timeframe-days-of-week-array[].timeframe-weekly-sunday-begin-time-1`	string
`timeframe-days-of-week-array[].timeframe-weekly-sunday-end-time-1`	string
`timeframe-days-of-week-array[].timeframe-weekly-sunday-begin-time-2`	string
`timeframe-days-of-week-array[].timeframe-weekly-sunday-end-time-2`	string
`timeframe-days-of-week-array[].timeframe-weekly-monday-begin-time-1`	string
`timeframe-days-of-week-array[].timeframe-weekly-monday-end-time-1`	string
`timeframe-days-of-week-array[].timeframe-weekly-monday-begin-time-2`	string
`timeframe-days-of-week-array[].timeframe-weekly-monday-end-time-2`	string
`timeframe-days-of-week-array[].timeframe-weekly-tuesday-begin-time-1`	string
`timeframe-days-of-week-array[].timeframe-weekly-tuesday-end-time-1`	string
`timeframe-days-of-week-array[].timeframe-weekly-tuesday-begin-time-2`	string
`timeframe-days-of-week-array[].timeframe-weekly-tuesday-end-time-2`	string
`timeframe-days-of-week-array[].timeframe-weekly-wednesday-begin-time-1`	string
`timeframe-days-of-week-array[].timeframe-weekly-wednesday-end-time-1`	string
`timeframe-days-of-week-array[].timeframe-weekly-wednesday-begin-time-2`	string
`timeframe-days-of-week-array[].timeframe-weekly-wednesday-end-time-2`	string
`timeframe-days-of-week-array[].timeframe-weekly-thursday-begin-time-1`	string
`timeframe-days-of-week-array[].timeframe-weekly-thursday-end-time-1`	string
`timeframe-days-of-week-array[].timeframe-weekly-thursday-begin-time-2`	string
`timeframe-days-of-week-array[].timeframe-weekly-thursday-end-time-2`	string
`timeframe-days-of-week-array[].timeframe-weekly-friday-begin-time-1`	string
`timeframe-days-of-week-array[].timeframe-weekly-friday-end-time-1`	string
`timeframe-days-of-week-array[].timeframe-weekly-friday-begin-time-2`	string
`timeframe-days-of-week-array[].timeframe-weekly-friday-end-time-2`	string
`timeframe-days-of-week-array[].timeframe-weekly-saturday-begin-time-1`	string
`timeframe-days-of-week-array[].timeframe-weekly-saturday-end-time-1`	string
`timeframe-days-of-week-array[].timeframe-weekly-saturday-begin-time-2`	string
`timeframe-days-of-week-array[].timeframe-weekly-saturday-end-time-2`	string
`timeframe-days-of-week-array[].timeframe-recurrence-type` required	string
`timeframe-days-of-week-array[].timeframe-recurrence-begin-date` required	string	Timeframe recurrence begin (date).
`timeframe-days-of-week-array[].timeframe-recurrence-custom-interval` required	string
`timeframe-days-of-week-array[].timeframe-recurrence-custom-interval-count` required	string	Number of timeframe recurrence custom interval.
`timeframe-days-of-week-array[].timeframe-recurrence-custom-interval-option` required	string
`timeframe-days-of-week-array[].timeframe-recurrence-end-option` required	string
`timeframe-days-of-week-array[].timeframe-recurrence-end-date` required	string	Timeframe recurrence end (date).
`timeframe-days-of-week-array[].timeframe-expiry-datetime`	string	Timeframe expiry (date and time).
`timeframe-days-of-week-array[].domain`	string	The account the item belongs to.
`timeframe-days-of-week-array[].timeframe-next-observance-datetime`	array of number	Timeframe next observance (date and time).
`timeframe-days-of-week-array[].timeframe-recurrence-rrule`	string
`timeframe-days-of-week-array[].timeframe-is-v1`	boolean

Example request

curl -X POST "https://api.noodlevoice.com/ns-api/v2/domains/~/users/1001/timeframes/{id}" \
  -H "Authorization: Bearer $NOODLEVOICE_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "timeframe-specific-dates-array": [
      {
        "timeframe-specific-dates-begin-date": "2026-11-02",
        "timeframe-specific-dates-begin-time": "string",
        "timeframe-specific-dates-end-date": "2026-11-02",
        "timeframe-specific-dates-end-time": "string",
        "timeframe-recurrence-type": "string",
        "timeframe-recurrence-custom-interval-count": "string",
        "timeframe-recurrence-custom-interval": "string",
        "timeframe-recurrence-custom-interval-option": "string",
        "timeframe-recurrence-end-option": "string",
        "timeframe-recurrence-end-date": "2026-11-02"
      }
    ],
    "timeframe-days-of-week-array": [
      {
        "timeframe-recurrence-begin-date": "2026-11-02",
        "timeframe-recurrence-type": "string",
        "timeframe-recurrence-custom-interval-count": "string",
        "timeframe-recurrence-custom-interval": "string",
        "timeframe-recurrence-custom-interval-option": "string",
        "timeframe-recurrence-end-option": "string",
        "timeframe-recurrence-end-date": "2026-11-02"
      }
    ]
  }'

const res = await fetch("https://api.noodlevoice.com/ns-api/v2/domains/~/users/1001/timeframes/{id}", {
  method: "POST",
  headers: {
    Authorization: "Bearer " + process.env.NOODLEVOICE_KEY,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "timeframe-specific-dates-array": [
      {
        "timeframe-specific-dates-begin-date": "2026-11-02",
        "timeframe-specific-dates-begin-time": "string",
        "timeframe-specific-dates-end-date": "2026-11-02",
        "timeframe-specific-dates-end-time": "string",
        "timeframe-recurrence-type": "string",
        "timeframe-recurrence-custom-interval-count": "string",
        "timeframe-recurrence-custom-interval": "string",
        "timeframe-recurrence-custom-interval-option": "string",
        "timeframe-recurrence-end-option": "string",
        "timeframe-recurrence-end-date": "2026-11-02"
      }
    ],
    "timeframe-days-of-week-array": [
      {
        "timeframe-recurrence-begin-date": "2026-11-02",
        "timeframe-recurrence-type": "string",
        "timeframe-recurrence-custom-interval-count": "string",
        "timeframe-recurrence-custom-interval": "string",
        "timeframe-recurrence-custom-interval-option": "string",
        "timeframe-recurrence-end-option": "string",
        "timeframe-recurrence-end-date": "2026-11-02"
      }
    ]
  }),
});
const data = await res.json();

import os, requests

r = requests.post(
    "https://api.noodlevoice.com/ns-api/v2/domains/~/users/1001/timeframes/{id}",
    headers={"Authorization": "Bearer " + os.environ["NOODLEVOICE_KEY"]},
    json={
        "timeframe-specific-dates-array": [
            {
                "timeframe-specific-dates-begin-date": "2026-11-02",
                "timeframe-specific-dates-begin-time": "string",
                "timeframe-specific-dates-end-date": "2026-11-02",
                "timeframe-specific-dates-end-time": "string",
                "timeframe-recurrence-type": "string",
                "timeframe-recurrence-custom-interval-count": "string",
                "timeframe-recurrence-custom-interval": "string",
                "timeframe-recurrence-custom-interval-option": "string",
                "timeframe-recurrence-end-option": "string",
                "timeframe-recurrence-end-date": "2026-11-02"
            }
        ],
        "timeframe-days-of-week-array": [
            {
                "timeframe-recurrence-begin-date": "2026-11-02",
                "timeframe-recurrence-type": "string",
                "timeframe-recurrence-custom-interval-count": "string",
                "timeframe-recurrence-custom-interval": "string",
                "timeframe-recurrence-custom-interval-option": "string",
                "timeframe-recurrence-end-option": "string",
                "timeframe-recurrence-end-date": "2026-11-02"
            }
        ]
    },
)
print(r.status_code, r.json())

Response 202

Returns a status code with a short JSON message.

Other responses: 400, 401, 404. See errors.

Update date ranges in a user's time frame

PUT/domains/~/users/{user}/timeframes/{id}

Changes selected date ranges in one of a user's specific dates time frames.

Write Key Admin switch: Schedules (time frames), Write.

Parameters

Name	In	Type	Notes
`user` required	path	string	The user ID, usually their extension number, like `1001`. Default `~` Min length 0 Max length 16
`id` required	path	string	The ID of the item, as returned when you list or create it.

Request body application/json

Field	Type	Notes
`update_only` required	string	Set to `yes` to change only the entries you send and keep the rest.
`timeframe-specific-dates-array`	array of object
`timeframe-specific-dates-array[].timeframe-id`	string	The time frame's ID.
`timeframe-specific-dates-array[].timeframe-parent-id`	string	ID of the timeframe parent.
`timeframe-specific-dates-array[].ordinal-order`	number
`timeframe-specific-dates-array[].timeframe-specific-dates-begin-date` required	string	Timeframe specific dates begin (date).
`timeframe-specific-dates-array[].timeframe-specific-dates-begin-time` required	string
`timeframe-specific-dates-array[].timeframe-specific-dates-end-date` required	string	Timeframe specific dates end (date).
`timeframe-specific-dates-array[].timeframe-specific-dates-end-time` required	string
`timeframe-specific-dates-array[].timeframe-recurrence-type` required	string
`timeframe-specific-dates-array[].timeframe-recurrence-custom-interval` required	string
`timeframe-specific-dates-array[].timeframe-recurrence-custom-interval-count` required	string	Number of timeframe recurrence custom interval.
`timeframe-specific-dates-array[].timeframe-recurrence-custom-interval-option` required	string
`timeframe-specific-dates-array[].timeframe-recurrence-end-option` required	string
`timeframe-specific-dates-array[].timeframe-recurrence-end-date` required	string	Timeframe recurrence end (date).
`timeframe-specific-dates-array[].timeframe-expiry-datetime`	string	Timeframe expiry (date and time).
`timeframe-specific-dates-array[].domain`	string	The account the item belongs to.
`timeframe-specific-dates-array[].timeframe-recurrence-rrule`	string
`timeframe-specific-dates-array[].timeframe-next-observance-datetime`	array of number	Timeframe next observance (date and time).
`timeframe-specific-dates-array[].timeframe-is-v1`	boolean

Example request

curl -X PUT "https://api.noodlevoice.com/ns-api/v2/domains/~/users/1001/timeframes/{id}" \
  -H "Authorization: Bearer $NOODLEVOICE_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "update_only": "string"
  }'

const res = await fetch("https://api.noodlevoice.com/ns-api/v2/domains/~/users/1001/timeframes/{id}", {
  method: "PUT",
  headers: {
    Authorization: "Bearer " + process.env.NOODLEVOICE_KEY,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "update_only": "string"
  }),
});
const data = await res.json();

import os, requests

r = requests.put(
    "https://api.noodlevoice.com/ns-api/v2/domains/~/users/1001/timeframes/{id}",
    headers={"Authorization": "Bearer " + os.environ["NOODLEVOICE_KEY"]},
    json={
        "update_only": "string"
    },
)
print(r.status_code, r.json())

Response 200

Returns a status code with a short JSON message.

Other responses: 400, 401, 404. See errors.

Update weekly hours in a user's time frame

PUT/domains/~/users/{user}/timeframes/{id}

Changes the weekly hours of one of a user's days of week time frames.

Write Key Admin switch: Schedules (time frames), Write.

Parameters

Name	In	Type	Notes
`user` required	path	string	The user ID, usually their extension number, like `1001`. Default `~` Min length 0 Max length 16
`id` required	path	string	The ID of the item, as returned when you list or create it.

Request body application/json

Field	Type	Notes
`update-only` required	string	Set to `yes` to change only the entries you send and keep the rest.
`timeframe-days-of-week-array`	array of object
`timeframe-days-of-week-array[].timeframe-id`	string	The time frame's ID.
`timeframe-days-of-week-array[].timeframe-parent-id`	string	ID of the timeframe parent.
`timeframe-days-of-week-array[].ordinal-order`	number
`timeframe-days-of-week-array[].timeframe-weekly-sunday-begin-time-1`	string
`timeframe-days-of-week-array[].timeframe-weekly-sunday-end-time-1`	string
`timeframe-days-of-week-array[].timeframe-weekly-sunday-begin-time-2`	string
`timeframe-days-of-week-array[].timeframe-weekly-sunday-end-time-2`	string
`timeframe-days-of-week-array[].timeframe-weekly-monday-begin-time-1`	string
`timeframe-days-of-week-array[].timeframe-weekly-monday-end-time-1`	string
`timeframe-days-of-week-array[].timeframe-weekly-monday-begin-time-2`	string
`timeframe-days-of-week-array[].timeframe-weekly-monday-end-time-2`	string
`timeframe-days-of-week-array[].timeframe-weekly-tuesday-begin-time-1`	string
`timeframe-days-of-week-array[].timeframe-weekly-tuesday-end-time-1`	string
`timeframe-days-of-week-array[].timeframe-weekly-tuesday-begin-time-2`	string
`timeframe-days-of-week-array[].timeframe-weekly-tuesday-end-time-2`	string
`timeframe-days-of-week-array[].timeframe-weekly-wednesday-begin-time-1`	string
`timeframe-days-of-week-array[].timeframe-weekly-wednesday-end-time-1`	string
`timeframe-days-of-week-array[].timeframe-weekly-wednesday-begin-time-2`	string
`timeframe-days-of-week-array[].timeframe-weekly-wednesday-end-time-2`	string
`timeframe-days-of-week-array[].timeframe-weekly-thursday-begin-time-1`	string
`timeframe-days-of-week-array[].timeframe-weekly-thursday-end-time-1`	string
`timeframe-days-of-week-array[].timeframe-weekly-thursday-begin-time-2`	string
`timeframe-days-of-week-array[].timeframe-weekly-thursday-end-time-2`	string
`timeframe-days-of-week-array[].timeframe-weekly-friday-begin-time-1`	string
`timeframe-days-of-week-array[].timeframe-weekly-friday-end-time-1`	string
`timeframe-days-of-week-array[].timeframe-weekly-friday-begin-time-2`	string
`timeframe-days-of-week-array[].timeframe-weekly-friday-end-time-2`	string
`timeframe-days-of-week-array[].timeframe-weekly-saturday-begin-time-1`	string
`timeframe-days-of-week-array[].timeframe-weekly-saturday-end-time-1`	string
`timeframe-days-of-week-array[].timeframe-weekly-saturday-begin-time-2`	string
`timeframe-days-of-week-array[].timeframe-weekly-saturday-end-time-2`	string
`timeframe-days-of-week-array[].timeframe-recurrence-type` required	string
`timeframe-days-of-week-array[].timeframe-recurrence-begin-date` required	string	Timeframe recurrence begin (date).
`timeframe-days-of-week-array[].timeframe-recurrence-custom-interval` required	string
`timeframe-days-of-week-array[].timeframe-recurrence-custom-interval-count` required	string	Number of timeframe recurrence custom interval.
`timeframe-days-of-week-array[].timeframe-recurrence-custom-interval-option` required	string
`timeframe-days-of-week-array[].timeframe-recurrence-end-option` required	string
`timeframe-days-of-week-array[].timeframe-recurrence-end-date` required	string	Timeframe recurrence end (date).
`timeframe-days-of-week-array[].timeframe-expiry-datetime`	string	Timeframe expiry (date and time).
`timeframe-days-of-week-array[].domain`	string	The account the item belongs to.
`timeframe-days-of-week-array[].timeframe-next-observance-datetime`	array of number	Timeframe next observance (date and time).
`timeframe-days-of-week-array[].timeframe-recurrence-rrule`	string
`timeframe-days-of-week-array[].timeframe-is-v1`	boolean

Example request

curl -X PUT "https://api.noodlevoice.com/ns-api/v2/domains/~/users/1001/timeframes/{id}" \
  -H "Authorization: Bearer $NOODLEVOICE_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "update-only": "string"
  }'

const res = await fetch("https://api.noodlevoice.com/ns-api/v2/domains/~/users/1001/timeframes/{id}", {
  method: "PUT",
  headers: {
    Authorization: "Bearer " + process.env.NOODLEVOICE_KEY,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "update-only": "string"
  }),
});
const data = await res.json();

import os, requests

r = requests.put(
    "https://api.noodlevoice.com/ns-api/v2/domains/~/users/1001/timeframes/{id}",
    headers={"Authorization": "Bearer " + os.environ["NOODLEVOICE_KEY"]},
    json={
        "update-only": "string"
    },
)
print(r.status_code, r.json())

Response 200

Returns a status code with a short JSON message.

Update holidays in a user's time frame

PUT/domains/~/users/{user}/timeframes/{id}

Changes selected holidays in one of a user's holidays time frames.

Write Key Admin switch: Schedules (time frames), Write.

Parameters

Name	In	Type	Notes
`user` required	path	string	The user ID, usually their extension number, like `1001`. Default `~` Min length 0 Max length 16
`id` required	path	string	The ID of the item, as returned when you list or create it.

Request body application/json

Field	Type	Notes
`update-only` required	string	Set to `yes` to change only the entries you send and keep the rest.
`timeframe-holiday-array`	array of object
`timeframe-holiday-array[].timeframe-id`	string	The time frame's ID.
`timeframe-holiday-array[].timeframe-parent-id`	string	ID of the timeframe parent.
`timeframe-holiday-array[].ordinal-order`	number
`timeframe-holiday-array[].timeframe-holiday-uuid` required	string
`timeframe-holiday-array[].timeframe-holiday-name` required	string	Name of the timeframe holiday.
`timeframe-holiday-array[].timeframe-holiday-begin-date` required	string	Timeframe holiday begin (date).
`timeframe-holiday-array[].country-abbreviation` required	string
`timeframe-holiday-array[].state-province-abbreviation` required	string
`timeframe-holiday-array[].holiday-api-location-hint` required	string
`timeframe-holiday-array[].timeframe-holiday-begin-time-1` required	string
`timeframe-holiday-array[].timeframe-holiday-end-time-1` required	string
`timeframe-holiday-array[].timeframe-holiday-begin-time-2` required	string
`timeframe-holiday-array[].timeframe-holiday-end-time-2` required	string
`timeframe-holiday-array[].timeframe-weekly-monday-observance-option` required	string
`timeframe-holiday-array[].timeframe-weekly-tuesday-observance-option` required	string
`timeframe-holiday-array[].timeframe-weekly-wednesday-observance-option` required	string
`timeframe-holiday-array[].timeframe-weekly-thursday-observance-option` required	string
`timeframe-holiday-array[].timeframe-weekly-friday-observance-option` required	string
`timeframe-holiday-array[].timeframe-weekly-saturday-observance-option` required	string
`timeframe-holiday-array[].timeframe-weekly-sunday-observance-option` required	string
`timeframe-holiday-array[].timeframe-workweek-list` required	string
`timeframe-holiday-array[].timeframe-recurrence-type` required	string
`timeframe-holiday-array[].timeframe-recurrence-end-option` required	string
`timeframe-holiday-array[].timeframe-recurrence-end-date` required	string	Timeframe recurrence end (date).
`timeframe-holiday-array[].timeframe-expiry-datetime`	string	Timeframe expiry (date and time).
`timeframe-holiday-array[].domain`	string	The account the item belongs to.
`timeframe-holiday-array[].timeframe-next-observance-datetime`	array of number	Timeframe next observance (date and time).

Example request

curl -X PUT "https://api.noodlevoice.com/ns-api/v2/domains/~/users/1001/timeframes/{id}" \
  -H "Authorization: Bearer $NOODLEVOICE_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "update-only": "string"
  }'

const res = await fetch("https://api.noodlevoice.com/ns-api/v2/domains/~/users/1001/timeframes/{id}", {
  method: "PUT",
  headers: {
    Authorization: "Bearer " + process.env.NOODLEVOICE_KEY,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "update-only": "string"
  }),
});
const data = await res.json();

import os, requests

r = requests.put(
    "https://api.noodlevoice.com/ns-api/v2/domains/~/users/1001/timeframes/{id}",
    headers={"Authorization": "Bearer " + os.environ["NOODLEVOICE_KEY"]},
    json={
        "update-only": "string"
    },
)
print(r.status_code, r.json())

Response 200

Returns a status code with a short JSON message.

Other responses: 400, 401, 404. See errors.

Replace holidays in a user's time frame

PUT/domains/~/users/{user}/timeframes/{id}

Replaces every holiday in one of a user's holidays time frames.

Write Key Admin switch: Schedules (time frames), Write.

Parameters

Name	In	Type	Notes
`user` required	path	string	The user ID, usually their extension number, like `1001`. Default `~` Min length 0 Max length 16
`id` required	path	string	The ID of the item, as returned when you list or create it.

Request body application/json

Field	Type	Notes
`timeframe-holiday-array`	array of object
`timeframe-holiday-array[].timeframe-id`	string	The time frame's ID.
`timeframe-holiday-array[].timeframe-parent-id`	string	ID of the timeframe parent.
`timeframe-holiday-array[].ordinal-order`	number
`timeframe-holiday-array[].timeframe-holiday-uuid` required	string
`timeframe-holiday-array[].timeframe-holiday-name` required	string	Name of the timeframe holiday.
`timeframe-holiday-array[].timeframe-holiday-begin-date` required	string	Timeframe holiday begin (date).
`timeframe-holiday-array[].country-abbreviation` required	string
`timeframe-holiday-array[].state-province-abbreviation` required	string
`timeframe-holiday-array[].holiday-api-location-hint` required	string
`timeframe-holiday-array[].timeframe-holiday-begin-time-1` required	string
`timeframe-holiday-array[].timeframe-holiday-end-time-1` required	string
`timeframe-holiday-array[].timeframe-holiday-begin-time-2` required	string
`timeframe-holiday-array[].timeframe-holiday-end-time-2` required	string
`timeframe-holiday-array[].timeframe-weekly-monday-observance-option` required	string
`timeframe-holiday-array[].timeframe-weekly-tuesday-observance-option` required	string
`timeframe-holiday-array[].timeframe-weekly-wednesday-observance-option` required	string
`timeframe-holiday-array[].timeframe-weekly-thursday-observance-option` required	string
`timeframe-holiday-array[].timeframe-weekly-friday-observance-option` required	string
`timeframe-holiday-array[].timeframe-weekly-saturday-observance-option` required	string
`timeframe-holiday-array[].timeframe-weekly-sunday-observance-option` required	string
`timeframe-holiday-array[].timeframe-workweek-list` required	string
`timeframe-holiday-array[].timeframe-recurrence-type` required	string
`timeframe-holiday-array[].timeframe-recurrence-end-option` required	string
`timeframe-holiday-array[].timeframe-recurrence-end-date` required	string	Timeframe recurrence end (date).
`timeframe-holiday-array[].timeframe-expiry-datetime`	string	Timeframe expiry (date and time).
`timeframe-holiday-array[].domain`	string	The account the item belongs to.
`timeframe-holiday-array[].timeframe-next-observance-datetime`	array of number	Timeframe next observance (date and time).

Example request

curl -X PUT "https://api.noodlevoice.com/ns-api/v2/domains/~/users/1001/timeframes/{id}" \
  -H "Authorization: Bearer $NOODLEVOICE_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "timeframe-holiday-array": [
      {
        "timeframe-holiday-uuid": "string",
        "timeframe-holiday-name": "Front Desk",
        "timeframe-holiday-begin-date": "2026-11-02",
        "country-abbreviation": "string",
        "state-province-abbreviation": "string",
        "holiday-api-location-hint": "string",
        "timeframe-holiday-begin-time-1": "string",
        "timeframe-holiday-end-time-1": "string",
        "timeframe-holiday-begin-time-2": "string",
        "timeframe-holiday-end-time-2": "string",
        "timeframe-weekly-monday-observance-option": "string",
        "timeframe-weekly-tuesday-observance-option": "string",
        "timeframe-weekly-wednesday-observance-option": "string",
        "timeframe-weekly-thursday-observance-option": "string",
        "timeframe-weekly-friday-observance-option": "string",
        "timeframe-weekly-saturday-observance-option": "string",
        "timeframe-weekly-sunday-observance-option": "string",
        "timeframe-workweek-list": "string",
        "timeframe-recurrence-type": "string",
        "timeframe-recurrence-end-option": "string",
        "timeframe-recurrence-end-date": "2026-11-02"
      }
    ]
  }'

const res = await fetch("https://api.noodlevoice.com/ns-api/v2/domains/~/users/1001/timeframes/{id}", {
  method: "PUT",
  headers: {
    Authorization: "Bearer " + process.env.NOODLEVOICE_KEY,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "timeframe-holiday-array": [
      {
        "timeframe-holiday-uuid": "string",
        "timeframe-holiday-name": "Front Desk",
        "timeframe-holiday-begin-date": "2026-11-02",
        "country-abbreviation": "string",
        "state-province-abbreviation": "string",
        "holiday-api-location-hint": "string",
        "timeframe-holiday-begin-time-1": "string",
        "timeframe-holiday-end-time-1": "string",
        "timeframe-holiday-begin-time-2": "string",
        "timeframe-holiday-end-time-2": "string",
        "timeframe-weekly-monday-observance-option": "string",
        "timeframe-weekly-tuesday-observance-option": "string",
        "timeframe-weekly-wednesday-observance-option": "string",
        "timeframe-weekly-thursday-observance-option": "string",
        "timeframe-weekly-friday-observance-option": "string",
        "timeframe-weekly-saturday-observance-option": "string",
        "timeframe-weekly-sunday-observance-option": "string",
        "timeframe-workweek-list": "string",
        "timeframe-recurrence-type": "string",
        "timeframe-recurrence-end-option": "string",
        "timeframe-recurrence-end-date": "2026-11-02"
      }
    ]
  }),
});
const data = await res.json();

import os, requests

r = requests.put(
    "https://api.noodlevoice.com/ns-api/v2/domains/~/users/1001/timeframes/{id}",
    headers={"Authorization": "Bearer " + os.environ["NOODLEVOICE_KEY"]},
    json={
        "timeframe-holiday-array": [
            {
                "timeframe-holiday-uuid": "string",
                "timeframe-holiday-name": "Front Desk",
                "timeframe-holiday-begin-date": "2026-11-02",
                "country-abbreviation": "string",
                "state-province-abbreviation": "string",
                "holiday-api-location-hint": "string",
                "timeframe-holiday-begin-time-1": "string",
                "timeframe-holiday-end-time-1": "string",
                "timeframe-holiday-begin-time-2": "string",
                "timeframe-holiday-end-time-2": "string",
                "timeframe-weekly-monday-observance-option": "string",
                "timeframe-weekly-tuesday-observance-option": "string",
                "timeframe-weekly-wednesday-observance-option": "string",
                "timeframe-weekly-thursday-observance-option": "string",
                "timeframe-weekly-friday-observance-option": "string",
                "timeframe-weekly-saturday-observance-option": "string",
                "timeframe-weekly-sunday-observance-option": "string",
                "timeframe-workweek-list": "string",
                "timeframe-recurrence-type": "string",
                "timeframe-recurrence-end-option": "string",
                "timeframe-recurrence-end-date": "2026-11-02"
            }
        ]
    },
)
print(r.status_code, r.json())

Response 200

Returns a status code with a short JSON message.

Update entries in a user's custom time frame

PUT/domains/~/users/{user}/timeframes/{id}

Changes selected entries in one of a user's custom time frames.

Write Key Admin switch: Schedules (time frames), Write.

Parameters

Name	In	Type	Notes
`user` required	path	string	The user ID, usually their extension number, like `1001`. Default `~` Min length 0 Max length 16
`id` required	path	string	The ID of the item, as returned when you list or create it.

Request body application/json

Field	Type	Notes
`update-only` required	string	Set to `yes` to change only the entries you send and keep the rest.
`timeframe-specific-dates-array`	array of object
`timeframe-specific-dates-array[].timeframe-id`	string	The time frame's ID.
`timeframe-specific-dates-array[].timeframe-parent-id`	string	ID of the timeframe parent.
`timeframe-specific-dates-array[].ordinal-order`	number
`timeframe-specific-dates-array[].timeframe-specific-dates-begin-date` required	string	Timeframe specific dates begin (date).
`timeframe-specific-dates-array[].timeframe-specific-dates-begin-time` required	string
`timeframe-specific-dates-array[].timeframe-specific-dates-end-date` required	string	Timeframe specific dates end (date).
`timeframe-specific-dates-array[].timeframe-specific-dates-end-time` required	string
`timeframe-specific-dates-array[].timeframe-recurrence-type` required	string
`timeframe-specific-dates-array[].timeframe-recurrence-custom-interval` required	string
`timeframe-specific-dates-array[].timeframe-recurrence-custom-interval-count` required	string	Number of timeframe recurrence custom interval.
`timeframe-specific-dates-array[].timeframe-recurrence-custom-interval-option` required	string
`timeframe-specific-dates-array[].timeframe-recurrence-end-option` required	string
`timeframe-specific-dates-array[].timeframe-recurrence-end-date` required	string	Timeframe recurrence end (date).
`timeframe-specific-dates-array[].timeframe-expiry-datetime`	string	Timeframe expiry (date and time).
`timeframe-specific-dates-array[].domain`	string	The account the item belongs to.
`timeframe-specific-dates-array[].timeframe-recurrence-rrule`	string
`timeframe-specific-dates-array[].timeframe-next-observance-datetime`	array of number	Timeframe next observance (date and time).
`timeframe-specific-dates-array[].timeframe-is-v1`	boolean
`timeframe-holiday-array`	array of object
`timeframe-holiday-array[].timeframe-id`	string	The time frame's ID.
`timeframe-holiday-array[].timeframe-parent-id`	string	ID of the timeframe parent.
`timeframe-holiday-array[].ordinal-order`	number
`timeframe-holiday-array[].timeframe-holiday-uuid` required	string
`timeframe-holiday-array[].timeframe-holiday-name` required	string	Name of the timeframe holiday.
`timeframe-holiday-array[].timeframe-holiday-begin-date` required	string	Timeframe holiday begin (date).
`timeframe-holiday-array[].country-abbreviation` required	string
`timeframe-holiday-array[].state-province-abbreviation` required	string
`timeframe-holiday-array[].holiday-api-location-hint` required	string
`timeframe-holiday-array[].timeframe-holiday-begin-time-1` required	string
`timeframe-holiday-array[].timeframe-holiday-end-time-1` required	string
`timeframe-holiday-array[].timeframe-holiday-begin-time-2` required	string
`timeframe-holiday-array[].timeframe-holiday-end-time-2` required	string
`timeframe-holiday-array[].timeframe-weekly-monday-observance-option` required	string
`timeframe-holiday-array[].timeframe-weekly-tuesday-observance-option` required	string
`timeframe-holiday-array[].timeframe-weekly-wednesday-observance-option` required	string
`timeframe-holiday-array[].timeframe-weekly-thursday-observance-option` required	string
`timeframe-holiday-array[].timeframe-weekly-friday-observance-option` required	string
`timeframe-holiday-array[].timeframe-weekly-saturday-observance-option` required	string
`timeframe-holiday-array[].timeframe-weekly-sunday-observance-option` required	string
`timeframe-holiday-array[].timeframe-workweek-list` required	string
`timeframe-holiday-array[].timeframe-recurrence-type` required	string
`timeframe-holiday-array[].timeframe-recurrence-end-option` required	string
`timeframe-holiday-array[].timeframe-recurrence-end-date` required	string	Timeframe recurrence end (date).
`timeframe-holiday-array[].timeframe-expiry-datetime`	string	Timeframe expiry (date and time).
`timeframe-holiday-array[].domain`	string	The account the item belongs to.
`timeframe-holiday-array[].timeframe-next-observance-datetime`	array of number	Timeframe next observance (date and time).
`timeframe-days-of-week-array`	array of object
`timeframe-days-of-week-array[].timeframe-id`	string	The time frame's ID.
`timeframe-days-of-week-array[].timeframe-parent-id`	string	ID of the timeframe parent.
`timeframe-days-of-week-array[].ordinal-order`	number
`timeframe-days-of-week-array[].timeframe-weekly-sunday-begin-time-1`	string
`timeframe-days-of-week-array[].timeframe-weekly-sunday-end-time-1`	string
`timeframe-days-of-week-array[].timeframe-weekly-sunday-begin-time-2`	string
`timeframe-days-of-week-array[].timeframe-weekly-sunday-end-time-2`	string
`timeframe-days-of-week-array[].timeframe-weekly-monday-begin-time-1`	string
`timeframe-days-of-week-array[].timeframe-weekly-monday-end-time-1`	string
`timeframe-days-of-week-array[].timeframe-weekly-monday-begin-time-2`	string
`timeframe-days-of-week-array[].timeframe-weekly-monday-end-time-2`	string
`timeframe-days-of-week-array[].timeframe-weekly-tuesday-begin-time-1`	string
`timeframe-days-of-week-array[].timeframe-weekly-tuesday-end-time-1`	string
`timeframe-days-of-week-array[].timeframe-weekly-tuesday-begin-time-2`	string
`timeframe-days-of-week-array[].timeframe-weekly-tuesday-end-time-2`	string
`timeframe-days-of-week-array[].timeframe-weekly-wednesday-begin-time-1`	string
`timeframe-days-of-week-array[].timeframe-weekly-wednesday-end-time-1`	string
`timeframe-days-of-week-array[].timeframe-weekly-wednesday-begin-time-2`	string
`timeframe-days-of-week-array[].timeframe-weekly-wednesday-end-time-2`	string
`timeframe-days-of-week-array[].timeframe-weekly-thursday-begin-time-1`	string
`timeframe-days-of-week-array[].timeframe-weekly-thursday-end-time-1`	string
`timeframe-days-of-week-array[].timeframe-weekly-thursday-begin-time-2`	string
`timeframe-days-of-week-array[].timeframe-weekly-thursday-end-time-2`	string
`timeframe-days-of-week-array[].timeframe-weekly-friday-begin-time-1`	string
`timeframe-days-of-week-array[].timeframe-weekly-friday-end-time-1`	string
`timeframe-days-of-week-array[].timeframe-weekly-friday-begin-time-2`	string
`timeframe-days-of-week-array[].timeframe-weekly-friday-end-time-2`	string
`timeframe-days-of-week-array[].timeframe-weekly-saturday-begin-time-1`	string
`timeframe-days-of-week-array[].timeframe-weekly-saturday-end-time-1`	string
`timeframe-days-of-week-array[].timeframe-weekly-saturday-begin-time-2`	string
`timeframe-days-of-week-array[].timeframe-weekly-saturday-end-time-2`	string
`timeframe-days-of-week-array[].timeframe-recurrence-type` required	string
`timeframe-days-of-week-array[].timeframe-recurrence-begin-date` required	string	Timeframe recurrence begin (date).
`timeframe-days-of-week-array[].timeframe-recurrence-custom-interval` required	string
`timeframe-days-of-week-array[].timeframe-recurrence-custom-interval-count` required	string	Number of timeframe recurrence custom interval.
`timeframe-days-of-week-array[].timeframe-recurrence-custom-interval-option` required	string
`timeframe-days-of-week-array[].timeframe-recurrence-end-option` required	string
`timeframe-days-of-week-array[].timeframe-recurrence-end-date` required	string	Timeframe recurrence end (date).
`timeframe-days-of-week-array[].timeframe-expiry-datetime`	string	Timeframe expiry (date and time).
`timeframe-days-of-week-array[].domain`	string	The account the item belongs to.
`timeframe-days-of-week-array[].timeframe-next-observance-datetime`	array of number	Timeframe next observance (date and time).
`timeframe-days-of-week-array[].timeframe-recurrence-rrule`	string
`timeframe-days-of-week-array[].timeframe-is-v1`	boolean

Example request

curl -X PUT "https://api.noodlevoice.com/ns-api/v2/domains/~/users/1001/timeframes/{id}" \
  -H "Authorization: Bearer $NOODLEVOICE_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "update-only": "string"
  }'

const res = await fetch("https://api.noodlevoice.com/ns-api/v2/domains/~/users/1001/timeframes/{id}", {
  method: "PUT",
  headers: {
    Authorization: "Bearer " + process.env.NOODLEVOICE_KEY,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "update-only": "string"
  }),
});
const data = await res.json();

import os, requests

r = requests.put(
    "https://api.noodlevoice.com/ns-api/v2/domains/~/users/1001/timeframes/{id}",
    headers={"Authorization": "Bearer " + os.environ["NOODLEVOICE_KEY"]},
    json={
        "update-only": "string"
    },
)
print(r.status_code, r.json())

Response 200

Returns a status code with a short JSON message.

Replace entries in a user's custom time frame

PUT/domains/~/users/{user}/timeframes/{id}

Replaces every entry in one of a user's custom time frames.

Write Key Admin switch: Schedules (time frames), Write.

Parameters

Name	In	Type	Notes
`user` required	path	string	The user ID, usually their extension number, like `1001`. Default `~` Min length 0 Max length 16
`id` required	path	string	The ID of the item, as returned when you list or create it.

Request body application/json

Field	Type	Notes
`timeframe-specific-dates-array`	array of object
`timeframe-specific-dates-array[].timeframe-id`	string	The time frame's ID.
`timeframe-specific-dates-array[].timeframe-parent-id`	string	ID of the timeframe parent.
`timeframe-specific-dates-array[].ordinal-order`	number
`timeframe-specific-dates-array[].timeframe-specific-dates-begin-date` required	string	Timeframe specific dates begin (date).
`timeframe-specific-dates-array[].timeframe-specific-dates-begin-time` required	string
`timeframe-specific-dates-array[].timeframe-specific-dates-end-date` required	string	Timeframe specific dates end (date).
`timeframe-specific-dates-array[].timeframe-specific-dates-end-time` required	string
`timeframe-specific-dates-array[].timeframe-recurrence-type` required	string
`timeframe-specific-dates-array[].timeframe-recurrence-custom-interval` required	string
`timeframe-specific-dates-array[].timeframe-recurrence-custom-interval-count` required	string	Number of timeframe recurrence custom interval.
`timeframe-specific-dates-array[].timeframe-recurrence-custom-interval-option` required	string
`timeframe-specific-dates-array[].timeframe-recurrence-end-option` required	string
`timeframe-specific-dates-array[].timeframe-recurrence-end-date` required	string	Timeframe recurrence end (date).
`timeframe-specific-dates-array[].timeframe-expiry-datetime`	string	Timeframe expiry (date and time).
`timeframe-specific-dates-array[].domain`	string	The account the item belongs to.
`timeframe-specific-dates-array[].timeframe-recurrence-rrule`	string
`timeframe-specific-dates-array[].timeframe-next-observance-datetime`	array of number	Timeframe next observance (date and time).
`timeframe-specific-dates-array[].timeframe-is-v1`	boolean
`timeframe-holiday-array`	array of object
`timeframe-holiday-array[].timeframe-id`	string	The time frame's ID.
`timeframe-holiday-array[].timeframe-parent-id`	string	ID of the timeframe parent.
`timeframe-holiday-array[].ordinal-order`	number
`timeframe-holiday-array[].timeframe-holiday-uuid` required	string
`timeframe-holiday-array[].timeframe-holiday-name` required	string	Name of the timeframe holiday.
`timeframe-holiday-array[].timeframe-holiday-begin-date` required	string	Timeframe holiday begin (date).
`timeframe-holiday-array[].country-abbreviation` required	string
`timeframe-holiday-array[].state-province-abbreviation` required	string
`timeframe-holiday-array[].holiday-api-location-hint` required	string
`timeframe-holiday-array[].timeframe-holiday-begin-time-1` required	string
`timeframe-holiday-array[].timeframe-holiday-end-time-1` required	string
`timeframe-holiday-array[].timeframe-holiday-begin-time-2` required	string
`timeframe-holiday-array[].timeframe-holiday-end-time-2` required	string
`timeframe-holiday-array[].timeframe-weekly-monday-observance-option` required	string
`timeframe-holiday-array[].timeframe-weekly-tuesday-observance-option` required	string
`timeframe-holiday-array[].timeframe-weekly-wednesday-observance-option` required	string
`timeframe-holiday-array[].timeframe-weekly-thursday-observance-option` required	string
`timeframe-holiday-array[].timeframe-weekly-friday-observance-option` required	string
`timeframe-holiday-array[].timeframe-weekly-saturday-observance-option` required	string
`timeframe-holiday-array[].timeframe-weekly-sunday-observance-option` required	string
`timeframe-holiday-array[].timeframe-workweek-list` required	string
`timeframe-holiday-array[].timeframe-recurrence-type` required	string
`timeframe-holiday-array[].timeframe-recurrence-end-option` required	string
`timeframe-holiday-array[].timeframe-recurrence-end-date` required	string	Timeframe recurrence end (date).
`timeframe-holiday-array[].timeframe-expiry-datetime`	string	Timeframe expiry (date and time).
`timeframe-holiday-array[].domain`	string	The account the item belongs to.
`timeframe-holiday-array[].timeframe-next-observance-datetime`	array of number	Timeframe next observance (date and time).
`timeframe-days-of-week-array`	array of object
`timeframe-days-of-week-array[].timeframe-id`	string	The time frame's ID.
`timeframe-days-of-week-array[].timeframe-parent-id`	string	ID of the timeframe parent.
`timeframe-days-of-week-array[].ordinal-order`	number
`timeframe-days-of-week-array[].timeframe-weekly-sunday-begin-time-1`	string
`timeframe-days-of-week-array[].timeframe-weekly-sunday-end-time-1`	string
`timeframe-days-of-week-array[].timeframe-weekly-sunday-begin-time-2`	string
`timeframe-days-of-week-array[].timeframe-weekly-sunday-end-time-2`	string
`timeframe-days-of-week-array[].timeframe-weekly-monday-begin-time-1`	string
`timeframe-days-of-week-array[].timeframe-weekly-monday-end-time-1`	string
`timeframe-days-of-week-array[].timeframe-weekly-monday-begin-time-2`	string
`timeframe-days-of-week-array[].timeframe-weekly-monday-end-time-2`	string
`timeframe-days-of-week-array[].timeframe-weekly-tuesday-begin-time-1`	string
`timeframe-days-of-week-array[].timeframe-weekly-tuesday-end-time-1`	string
`timeframe-days-of-week-array[].timeframe-weekly-tuesday-begin-time-2`	string
`timeframe-days-of-week-array[].timeframe-weekly-tuesday-end-time-2`	string
`timeframe-days-of-week-array[].timeframe-weekly-wednesday-begin-time-1`	string
`timeframe-days-of-week-array[].timeframe-weekly-wednesday-end-time-1`	string
`timeframe-days-of-week-array[].timeframe-weekly-wednesday-begin-time-2`	string
`timeframe-days-of-week-array[].timeframe-weekly-wednesday-end-time-2`	string
`timeframe-days-of-week-array[].timeframe-weekly-thursday-begin-time-1`	string
`timeframe-days-of-week-array[].timeframe-weekly-thursday-end-time-1`	string
`timeframe-days-of-week-array[].timeframe-weekly-thursday-begin-time-2`	string
`timeframe-days-of-week-array[].timeframe-weekly-thursday-end-time-2`	string
`timeframe-days-of-week-array[].timeframe-weekly-friday-begin-time-1`	string
`timeframe-days-of-week-array[].timeframe-weekly-friday-end-time-1`	string
`timeframe-days-of-week-array[].timeframe-weekly-friday-begin-time-2`	string
`timeframe-days-of-week-array[].timeframe-weekly-friday-end-time-2`	string
`timeframe-days-of-week-array[].timeframe-weekly-saturday-begin-time-1`	string
`timeframe-days-of-week-array[].timeframe-weekly-saturday-end-time-1`	string
`timeframe-days-of-week-array[].timeframe-weekly-saturday-begin-time-2`	string
`timeframe-days-of-week-array[].timeframe-weekly-saturday-end-time-2`	string
`timeframe-days-of-week-array[].timeframe-recurrence-type` required	string
`timeframe-days-of-week-array[].timeframe-recurrence-begin-date` required	string	Timeframe recurrence begin (date).
`timeframe-days-of-week-array[].timeframe-recurrence-custom-interval` required	string
`timeframe-days-of-week-array[].timeframe-recurrence-custom-interval-count` required	string	Number of timeframe recurrence custom interval.
`timeframe-days-of-week-array[].timeframe-recurrence-custom-interval-option` required	string
`timeframe-days-of-week-array[].timeframe-recurrence-end-option` required	string
`timeframe-days-of-week-array[].timeframe-recurrence-end-date` required	string	Timeframe recurrence end (date).
`timeframe-days-of-week-array[].timeframe-expiry-datetime`	string	Timeframe expiry (date and time).
`timeframe-days-of-week-array[].domain`	string	The account the item belongs to.
`timeframe-days-of-week-array[].timeframe-next-observance-datetime`	array of number	Timeframe next observance (date and time).
`timeframe-days-of-week-array[].timeframe-recurrence-rrule`	string
`timeframe-days-of-week-array[].timeframe-is-v1`	boolean

Example request

curl -X PUT "https://api.noodlevoice.com/ns-api/v2/domains/~/users/1001/timeframes/{id}" \
  -H "Authorization: Bearer $NOODLEVOICE_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "timeframe-specific-dates-array": [
      {
        "timeframe-specific-dates-begin-date": "2026-11-02",
        "timeframe-specific-dates-begin-time": "string",
        "timeframe-specific-dates-end-date": "2026-11-02",
        "timeframe-specific-dates-end-time": "string",
        "timeframe-recurrence-type": "string",
        "timeframe-recurrence-custom-interval-count": "string",
        "timeframe-recurrence-custom-interval": "string",
        "timeframe-recurrence-custom-interval-option": "string",
        "timeframe-recurrence-end-option": "string",
        "timeframe-recurrence-end-date": "2026-11-02"
      }
    ],
    "timeframe-holiday-array": [
      {
        "timeframe-holiday-uuid": "string",
        "timeframe-holiday-name": "Front Desk",
        "timeframe-holiday-begin-date": "2026-11-02",
        "country-abbreviation": "string",
        "state-province-abbreviation": "string",
        "holiday-api-location-hint": "string",
        "timeframe-holiday-begin-time-1": "string",
        "timeframe-holiday-end-time-1": "string",
        "timeframe-holiday-begin-time-2": "string",
        "timeframe-holiday-end-time-2": "string",
        "timeframe-weekly-monday-observance-option": "string",
        "timeframe-weekly-tuesday-observance-option": "string",
        "timeframe-weekly-wednesday-observance-option": "string",
        "timeframe-weekly-thursday-observance-option": "string",
        "timeframe-weekly-friday-observance-option": "string",
        "timeframe-weekly-saturday-observance-option": "string",
        "timeframe-weekly-sunday-observance-option": "string",
        "timeframe-workweek-list": "string",
        "timeframe-recurrence-type": "string",
        "timeframe-recurrence-end-option": "string",
        "timeframe-recurrence-end-date": "2026-11-02"
      }
    ],
    "timeframe-days-of-week-array": [
      {
        "timeframe-recurrence-begin-date": "2026-11-02",
        "timeframe-recurrence-type": "string",
        "timeframe-recurrence-custom-interval-count": "string",
        "timeframe-recurrence-custom-interval": "string",
        "timeframe-recurrence-custom-interval-option": "string",
        "timeframe-recurrence-end-option": "string",
        "timeframe-recurrence-end-date": "2026-11-02"
      }
    ]
  }'

const res = await fetch("https://api.noodlevoice.com/ns-api/v2/domains/~/users/1001/timeframes/{id}", {
  method: "PUT",
  headers: {
    Authorization: "Bearer " + process.env.NOODLEVOICE_KEY,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "timeframe-specific-dates-array": [
      {
        "timeframe-specific-dates-begin-date": "2026-11-02",
        "timeframe-specific-dates-begin-time": "string",
        "timeframe-specific-dates-end-date": "2026-11-02",
        "timeframe-specific-dates-end-time": "string",
        "timeframe-recurrence-type": "string",
        "timeframe-recurrence-custom-interval-count": "string",
        "timeframe-recurrence-custom-interval": "string",
        "timeframe-recurrence-custom-interval-option": "string",
        "timeframe-recurrence-end-option": "string",
        "timeframe-recurrence-end-date": "2026-11-02"
      }
    ],
    "timeframe-holiday-array": [
      {
        "timeframe-holiday-uuid": "string",
        "timeframe-holiday-name": "Front Desk",
        "timeframe-holiday-begin-date": "2026-11-02",
        "country-abbreviation": "string",
        "state-province-abbreviation": "string",
        "holiday-api-location-hint": "string",
        "timeframe-holiday-begin-time-1": "string",
        "timeframe-holiday-end-time-1": "string",
        "timeframe-holiday-begin-time-2": "string",
        "timeframe-holiday-end-time-2": "string",
        "timeframe-weekly-monday-observance-option": "string",
        "timeframe-weekly-tuesday-observance-option": "string",
        "timeframe-weekly-wednesday-observance-option": "string",
        "timeframe-weekly-thursday-observance-option": "string",
        "timeframe-weekly-friday-observance-option": "string",
        "timeframe-weekly-saturday-observance-option": "string",
        "timeframe-weekly-sunday-observance-option": "string",
        "timeframe-workweek-list": "string",
        "timeframe-recurrence-type": "string",
        "timeframe-recurrence-end-option": "string",
        "timeframe-recurrence-end-date": "2026-11-02"
      }
    ],
    "timeframe-days-of-week-array": [
      {
        "timeframe-recurrence-begin-date": "2026-11-02",
        "timeframe-recurrence-type": "string",
        "timeframe-recurrence-custom-interval-count": "string",
        "timeframe-recurrence-custom-interval": "string",
        "timeframe-recurrence-custom-interval-option": "string",
        "timeframe-recurrence-end-option": "string",
        "timeframe-recurrence-end-date": "2026-11-02"
      }
    ]
  }),
});
const data = await res.json();

import os, requests

r = requests.put(
    "https://api.noodlevoice.com/ns-api/v2/domains/~/users/1001/timeframes/{id}",
    headers={"Authorization": "Bearer " + os.environ["NOODLEVOICE_KEY"]},
    json={
        "timeframe-specific-dates-array": [
            {
                "timeframe-specific-dates-begin-date": "2026-11-02",
                "timeframe-specific-dates-begin-time": "string",
                "timeframe-specific-dates-end-date": "2026-11-02",
                "timeframe-specific-dates-end-time": "string",
                "timeframe-recurrence-type": "string",
                "timeframe-recurrence-custom-interval-count": "string",
                "timeframe-recurrence-custom-interval": "string",
                "timeframe-recurrence-custom-interval-option": "string",
                "timeframe-recurrence-end-option": "string",
                "timeframe-recurrence-end-date": "2026-11-02"
            }
        ],
        "timeframe-holiday-array": [
            {
                "timeframe-holiday-uuid": "string",
                "timeframe-holiday-name": "Front Desk",
                "timeframe-holiday-begin-date": "2026-11-02",
                "country-abbreviation": "string",
                "state-province-abbreviation": "string",
                "holiday-api-location-hint": "string",
                "timeframe-holiday-begin-time-1": "string",
                "timeframe-holiday-end-time-1": "string",
                "timeframe-holiday-begin-time-2": "string",
                "timeframe-holiday-end-time-2": "string",
                "timeframe-weekly-monday-observance-option": "string",
                "timeframe-weekly-tuesday-observance-option": "string",
                "timeframe-weekly-wednesday-observance-option": "string",
                "timeframe-weekly-thursday-observance-option": "string",
                "timeframe-weekly-friday-observance-option": "string",
                "timeframe-weekly-saturday-observance-option": "string",
                "timeframe-weekly-sunday-observance-option": "string",
                "timeframe-workweek-list": "string",
                "timeframe-recurrence-type": "string",
                "timeframe-recurrence-end-option": "string",
                "timeframe-recurrence-end-date": "2026-11-02"
            }
        ],
        "timeframe-days-of-week-array": [
            {
                "timeframe-recurrence-begin-date": "2026-11-02",
                "timeframe-recurrence-type": "string",
                "timeframe-recurrence-custom-interval-count": "string",
                "timeframe-recurrence-custom-interval": "string",
                "timeframe-recurrence-custom-interval-option": "string",
                "timeframe-recurrence-end-option": "string",
                "timeframe-recurrence-end-date": "2026-11-02"
            }
        ]
    },
)
print(r.status_code, r.json())

Response 200

Returns a status code with a short JSON message.

Change a user's time frame type

PUT/domains/~/users/{user}/timeframes/{id}

Converts one of a user's time frames to a different type.

Write Key Admin switch: Schedules (time frames), Write.

Parameters

Name	In	Type	Notes
`user` required	path	string	The user ID, usually their extension number, like `1001`. Default `~` Min length 0 Max length 16
`id` required	path	string	The ID of the item, as returned when you list or create it.

Request body application/json

Field	Type	Notes
`timeframe-type` required	string	What kind of time frame it is.

Example request

curl -X PUT "https://api.noodlevoice.com/ns-api/v2/domains/~/users/1001/timeframes/{id}" \
  -H "Authorization: Bearer $NOODLEVOICE_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "timeframe-type": "string"
  }'

const res = await fetch("https://api.noodlevoice.com/ns-api/v2/domains/~/users/1001/timeframes/{id}", {
  method: "PUT",
  headers: {
    Authorization: "Bearer " + process.env.NOODLEVOICE_KEY,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "timeframe-type": "string"
  }),
});
const data = await res.json();

import os, requests

r = requests.put(
    "https://api.noodlevoice.com/ns-api/v2/domains/~/users/1001/timeframes/{id}",
    headers={"Authorization": "Bearer " + os.environ["NOODLEVOICE_KEY"]},
    json={
        "timeframe-type": "string"
    },
)
print(r.status_code, r.json())

Response 200

Returns a status code with a short JSON message.

Replace date ranges in a user's time frame

PUT/domains/~/users/{user}/timeframes/{id}

Replaces every date range in one of a user's specific dates time frames.

Write Key Admin switch: Schedules (time frames), Write.

Parameters

Name	In	Type	Notes
`user` required	path	string	The user ID, usually their extension number, like `1001`. Default `~` Min length 0 Max length 16
`id` required	path	string	The ID of the item, as returned when you list or create it.

Request body application/json

Field	Type	Notes
`timeframe-specific-dates-array`	array of object
`timeframe-specific-dates-array[].timeframe-id`	string	The time frame's ID.
`timeframe-specific-dates-array[].timeframe-parent-id`	string	ID of the timeframe parent.
`timeframe-specific-dates-array[].ordinal-order`	number
`timeframe-specific-dates-array[].timeframe-specific-dates-begin-date` required	string	Timeframe specific dates begin (date).
`timeframe-specific-dates-array[].timeframe-specific-dates-begin-time` required	string
`timeframe-specific-dates-array[].timeframe-specific-dates-end-date` required	string	Timeframe specific dates end (date).
`timeframe-specific-dates-array[].timeframe-specific-dates-end-time` required	string
`timeframe-specific-dates-array[].timeframe-recurrence-type` required	string
`timeframe-specific-dates-array[].timeframe-recurrence-custom-interval` required	string
`timeframe-specific-dates-array[].timeframe-recurrence-custom-interval-count` required	string	Number of timeframe recurrence custom interval.
`timeframe-specific-dates-array[].timeframe-recurrence-custom-interval-option` required	string
`timeframe-specific-dates-array[].timeframe-recurrence-end-option` required	string
`timeframe-specific-dates-array[].timeframe-recurrence-end-date` required	string	Timeframe recurrence end (date).
`timeframe-specific-dates-array[].timeframe-expiry-datetime`	string	Timeframe expiry (date and time).
`timeframe-specific-dates-array[].domain`	string	The account the item belongs to.
`timeframe-specific-dates-array[].timeframe-recurrence-rrule`	string
`timeframe-specific-dates-array[].timeframe-next-observance-datetime`	array of number	Timeframe next observance (date and time).
`timeframe-specific-dates-array[].timeframe-is-v1`	boolean

Example request

curl -X PUT "https://api.noodlevoice.com/ns-api/v2/domains/~/users/1001/timeframes/{id}" \
  -H "Authorization: Bearer $NOODLEVOICE_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "timeframe-specific-dates-array": [
      {
        "timeframe-specific-dates-begin-date": "2026-11-02",
        "timeframe-specific-dates-begin-time": "string",
        "timeframe-specific-dates-end-date": "2026-11-02",
        "timeframe-specific-dates-end-time": "string",
        "timeframe-recurrence-type": "string",
        "timeframe-recurrence-custom-interval-count": "string",
        "timeframe-recurrence-custom-interval": "string",
        "timeframe-recurrence-custom-interval-option": "string",
        "timeframe-recurrence-end-option": "string",
        "timeframe-recurrence-end-date": "2026-11-02"
      }
    ]
  }'

const res = await fetch("https://api.noodlevoice.com/ns-api/v2/domains/~/users/1001/timeframes/{id}", {
  method: "PUT",
  headers: {
    Authorization: "Bearer " + process.env.NOODLEVOICE_KEY,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "timeframe-specific-dates-array": [
      {
        "timeframe-specific-dates-begin-date": "2026-11-02",
        "timeframe-specific-dates-begin-time": "string",
        "timeframe-specific-dates-end-date": "2026-11-02",
        "timeframe-specific-dates-end-time": "string",
        "timeframe-recurrence-type": "string",
        "timeframe-recurrence-custom-interval-count": "string",
        "timeframe-recurrence-custom-interval": "string",
        "timeframe-recurrence-custom-interval-option": "string",
        "timeframe-recurrence-end-option": "string",
        "timeframe-recurrence-end-date": "2026-11-02"
      }
    ]
  }),
});
const data = await res.json();

import os, requests

r = requests.put(
    "https://api.noodlevoice.com/ns-api/v2/domains/~/users/1001/timeframes/{id}",
    headers={"Authorization": "Bearer " + os.environ["NOODLEVOICE_KEY"]},
    json={
        "timeframe-specific-dates-array": [
            {
                "timeframe-specific-dates-begin-date": "2026-11-02",
                "timeframe-specific-dates-begin-time": "string",
                "timeframe-specific-dates-end-date": "2026-11-02",
                "timeframe-specific-dates-end-time": "string",
                "timeframe-recurrence-type": "string",
                "timeframe-recurrence-custom-interval-count": "string",
                "timeframe-recurrence-custom-interval": "string",
                "timeframe-recurrence-custom-interval-option": "string",
                "timeframe-recurrence-end-option": "string",
                "timeframe-recurrence-end-date": "2026-11-02"
            }
        ]
    },
)
print(r.status_code, r.json())

Response 200

Returns a status code with a short JSON message.

Remove a holiday from a user's time frame

DELETE/domains/~/users/{user}/timeframes/{id}

Deletes one holiday. Send its child id in the body.

Write Key Admin switch: Schedules (time frames), Write.

Parameters

Name	In	Type	Notes
`user` required	path	string	The user ID, usually their extension number, like `1001`. Default `~` Min length 0 Max length 16
`id` required	path	string	The ID of the item, as returned when you list or create it.

Request body application/json

Field	Type	Notes
`child_id` required	string	The ID of the entry inside the time frame.

Example request

curl -X DELETE "https://api.noodlevoice.com/ns-api/v2/domains/~/users/1001/timeframes/{id}" \
  -H "Authorization: Bearer $NOODLEVOICE_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "child_id": "string"
  }'

const res = await fetch("https://api.noodlevoice.com/ns-api/v2/domains/~/users/1001/timeframes/{id}", {
  method: "DELETE",
  headers: {
    Authorization: "Bearer " + process.env.NOODLEVOICE_KEY,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "child_id": "string"
  }),
});
const data = await res.json();

import os, requests

r = requests.delete(
    "https://api.noodlevoice.com/ns-api/v2/domains/~/users/1001/timeframes/{id}",
    headers={"Authorization": "Bearer " + os.environ["NOODLEVOICE_KEY"]},
    json={
        "child_id": "string"
    },
)
print(r.status_code, r.json())

Response 202

Returns a status code with a short JSON message.

Other responses: 400, 401, 404. See errors.

Remove an entry from a user's custom time frame

DELETE/domains/~/users/{user}/timeframes/{id}

Deletes one entry. Send its child id in the body.

Write Key Admin switch: Schedules (time frames), Write.

Parameters

Name	In	Type	Notes
`user` required	path	string	The user ID, usually their extension number, like `1001`. Default `~` Min length 0 Max length 16
`id` required	path	string	The ID of the item, as returned when you list or create it.

Request body application/json

Field	Type	Notes
`child_id` required	string	The ID of the entry inside the time frame.

Example request

curl -X DELETE "https://api.noodlevoice.com/ns-api/v2/domains/~/users/1001/timeframes/{id}" \
  -H "Authorization: Bearer $NOODLEVOICE_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "child_id": "string"
  }'

const res = await fetch("https://api.noodlevoice.com/ns-api/v2/domains/~/users/1001/timeframes/{id}", {
  method: "DELETE",
  headers: {
    Authorization: "Bearer " + process.env.NOODLEVOICE_KEY,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "child_id": "string"
  }),
});
const data = await res.json();

import os, requests

r = requests.delete(
    "https://api.noodlevoice.com/ns-api/v2/domains/~/users/1001/timeframes/{id}",
    headers={"Authorization": "Bearer " + os.environ["NOODLEVOICE_KEY"]},
    json={
        "child_id": "string"
    },
)
print(r.status_code, r.json())

Response 202

Returns a status code with a short JSON message.

Other responses: 400, 401, 404. See errors.

Delete a user's time frame

DELETE/domains/~/users/{user}/timeframes/{id}

Deletes one of a user's time frames and everything in it.

Write Key Admin switch: Schedules (time frames), Write.

Parameters

Name	In	Type	Notes
`user` required	path	string	The user ID, usually their extension number, like `1001`. Default `~` Min length 0 Max length 16
`id` required	path	string	The ID of the item, as returned when you list or create it.

Example request

curl -X DELETE "https://api.noodlevoice.com/ns-api/v2/domains/~/users/1001/timeframes/{id}" \
  -H "Authorization: Bearer $NOODLEVOICE_KEY"

const res = await fetch("https://api.noodlevoice.com/ns-api/v2/domains/~/users/1001/timeframes/{id}", {
  method: "DELETE",
  headers: {
    Authorization: "Bearer " + process.env.NOODLEVOICE_KEY,
  },
});
const data = await res.json();

import os, requests

r = requests.delete(
    "https://api.noodlevoice.com/ns-api/v2/domains/~/users/1001/timeframes/{id}",
    headers={"Authorization": "Bearer " + os.environ["NOODLEVOICE_KEY"]},
)
print(r.status_code, r.json())

Response 202

Returns a status code with a short JSON message.

Other responses: 400, 401, 404. See errors.

Remove a date range from a user's time frame

DELETE/domains/~/users/{user}/timeframes/{id}

Deletes one date range. Send its child id in the body.

Write Key Admin switch: Schedules (time frames), Write.

Parameters

Name	In	Type	Notes
`user` required	path	string	The user ID, usually their extension number, like `1001`. Default `~` Min length 0 Max length 16
`id` required	path	string	The ID of the item, as returned when you list or create it.

Request body application/json

Field	Type	Notes
`child_id` required	string	The ID of the entry inside the time frame.

Example request

curl -X DELETE "https://api.noodlevoice.com/ns-api/v2/domains/~/users/1001/timeframes/{id}" \
  -H "Authorization: Bearer $NOODLEVOICE_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "child_id": "string"
  }'

const res = await fetch("https://api.noodlevoice.com/ns-api/v2/domains/~/users/1001/timeframes/{id}", {
  method: "DELETE",
  headers: {
    Authorization: "Bearer " + process.env.NOODLEVOICE_KEY,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "child_id": "string"
  }),
});
const data = await res.json();

import os, requests

r = requests.delete(
    "https://api.noodlevoice.com/ns-api/v2/domains/~/users/1001/timeframes/{id}",
    headers={"Authorization": "Bearer " + os.environ["NOODLEVOICE_KEY"]},
    json={
        "child_id": "string"
    },
)
print(r.status_code, r.json())

Response 202

Returns a status code with a short JSON message.

Other responses: 400, 401, 404. See errors.