Update Entries within Custom Timeframe

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

In order to update entries within a Custom timeframe, include the parameter update_only and provide within the arrays timeframe-specific-dates-array, timeframe-day-of-week-array, and/or timeframe-holiday-array the new values for the entries you intend to update, including in each entry the associated timeframe-id for that entry. If any entries are missing the timeframe-id parameter, it may result in undesired behavior.

The value for update-only must be set to yes for this operation to succeed as desired. If any other value is supplied or the parameter update-only is omitted, it will result in the behavior described in "Replace All Entries in Custom Timeframe" - see examples for more information.

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.

string

required

timeframe-id of the timeframe to modify

Body Params

update-only

string

required

The value for update-only must be set to yes for this operation to succeed as desired. If any other value is supplied or the parameter update-only is omitted, undesired behavior will occur.

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/~/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