Replace All Entries in Custom Timeframe

put https://{server}/ns-api/v2/domains/{domain}/users/{user}/timeframes/{id}#6

If a new array of entries is supplied in the update request for a Custom timeframe, it will replace all existing entries in the timeframe, meaning that any existing entries in that timeframe will be removed. To update individual entries within a Custom timeframe, refer to "Update Entries within Custom Timeframe." It is not necessary to supply a timeframe-id for the new holidays. These timeframe-ids will be generated automatically.

Path Params

domain

string

required

length ≤ 64

Defaults to ~

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

user

string

required

length between 0 and 16

Defaults to ~

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

string

required

timeframe-id of the timeframe to modify

Body Params

timeframe-specific-dates-array

array of objects

timeframe-specific-dates-array

timeframe-holiday-array

array of objects

timeframe-holiday-array

timeframe-days-of-week-array

array of objects

timeframe-days-of-week-array

Responses

Language

Credentials

Bearer

URL


xxxxxxxxxx
1
curl --request PUT \
2
     --url 'https://ns-api.com/ns-api/v2/domains/~/users/~/timeframes/id#6' \
3
     --header 'accept: application/json' \
4
     --header 'content-type: application/json'

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200OK

400Bad Request

401Authentication Required

404Record not found