Update Entries within Custom Timeframe

PUT

/domains/{domain}/users/{user}/timeframes/{id}HASHHACK5

Last modified:2025-03-27 00:15:56

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.

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

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

Path Params

domain

string

required

Example:

user

string

required

Example:

string

required

timeframe-id of the timeframe to modify

Body Params application/json

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[object (TimeframeSpecificDate) {11}]

optional

timeframe-id

string

optional

timeframe-specific-dates-begin-date

string

required

Start date of the specific date period - format: YYYYMMDD

timeframe-specific-dates-begin-time

string

required

Start time of the specific date period - format: hhmm (24 hour)

timeframe-specific-dates-end-date

string

required

End date of the specific date period - format: YYYYMMDD

timeframe-specific-dates-end-time

string

required

End time of the specific date period - format: hhmm (24 hour)

timeframe-recurrence-type

string

required

doesNotRecur: no recurrence

monthly-on-last-day: every month on the last day of the month

monthly-on-first-last: monthly on the first or last ordinal weekday, e.g.: the first Friday, the last Thursday - note: this will produce potentially unexpected behavior if used with a date that is not the first or last occurrence of that particular weekday

monthly-on-ordinal-weekday: can be used for any ordinal weekday that is NOT the first or last occurrence of that weekday in the given month e.g. the third Friday, the second Monday

monthly-date: every month on the same day, e.g.: the 14th day, the 29th day - note: if there are months in which the “day” does not occur, the date will not be active during that month, e.g.: the 31st day of February

yearly-on-selected-dates: every year on the exact month and day, e.g.: April 30th, September 4th

annual-month-day: functionally identical to yearly-on-selected-dates

yearly-first: every year on the first ordinal weekday of the exact month, e.g.: the first Monday of every June, the first Friday of every August - note: this will produce potentially unexpected behavior if used with a date that is not the first occurrence of that particular weekday

yearly-last: every year on the last ordinal weekday of the exact month, e.g.: the last Friday of every July, the last Tuesday of every November - note: this will produce potentially unexpected behavior if used with a date that is not the last occurrence of that particular weekday

custom: if this option is selected the fields timeframe-recurrence-custom-interval, timeframe-recurrence-custom-interval-option, and timeframe-recurrence-custom-interval-count must be set correctly to produce any behavior

timeframe-recurrence-custom-interval

string

required

Must be combined with the field timeframe-recurrence-custom-interval-count

days: recur every timeframe-recurrence-custom-interval-count days
weeks: recur every timeframe-recurrence-custom-interval-count weeks
months: recur every timeframe-recurrence-custom-interval-count months
years: recur every timeframe-recurrence-custom-interval-count years

timeframe-recurrence-custom-interval-count

string

required

Specifies the recurrence count based on the period specified in timeframe-recurrence-custom-interval-count e.g. 'every 6 days' or 'every 3 months'

If the field timeframe-recurrence-custom-interval-count is set to months this field determines the count in combination with the option set in timeframe-recurrence-custom-interval-option, if timeframe-recurrence-custom-interval is set to years the count is fixed to a value of 1 and will recur every year according to the option set in timeframe-recurrence-custom-interval-option

timeframe-recurrence-custom-interval-option

string

required

If timeframe-recurrence-custom-interval is set to days or weeks this field is not used. This field is for months and years only.

For timeframe-recurrence-custom-interval of months:
monthly-same-day: recur on the same day of the month, e.g.: the 14th day, the 29th day - note: if there are months in which the “day” does not occur, the date will not be active during that month, e.g.: the 31st day of February
monthly-ordinal-weekday: recur on the same ordinal weekday e.g. the third Friday, the second Monday
monthly-first-last-weekday: recur on the first or last instance of the selected weekday in the month, e.g.: the first Wednesday, the last Tuesday - note: this will produce potentially unexpected behavior if used with a date that is not the first or last occurrence of that particular weekday
monthly-on-last-day: recur on the last day of the month - note: this will produce potentially unexpected behavior if used with a date that is not the last day of the month

For timeframe-recurrence-custom-interval of years:
yearly-same-day: recur on the same day of the same month, e.g.: the 10th of May, the 20th of October
yearly-ordinal-weekday: recur on the same ordinal weekday of the same month, e.g.: the second Tuesday of April, the third Thursday of November
yearly-first-last-weekday: recur on the first or last weekday of the same month, e.g.: the third Wednesday of August, the first Tuesday of December - note: this will produce potentially unexpected behavior if used with a date that is not the first or last occurrence of that particular weekday

timeframe-recurrence-end-option

string

required

never: recurrence will continue indefinitely

onADate: recurrence will end on a date, specified in timeframe-recurrence-end-date

timeframe-recurrence-end-date

string

required

End date of the recurrence - format: YYYYMMDD

timeframe-holiday-array

array[object (TimeframeHoliday) {23}]

optional

timeframe-id

string

optional

timeframe-holiday-uuid

string

required

UUID of the holiday as provided by the Holiday API

timeframe-holiday-name

string

required

Name of holiday as provided by the Holiday API

timeframe-holiday-begin-date

string

required

First desired occurrence of the holiday - format: YYYYMMDD

country-abbreviation

string

required

Country of the holiday as provided by the Holiday API

state-province-abbreviation

string

required

Region of the holiday as provided by the Holiday API, formatted according to ISO 3166-2 standard.e.g.:US-CA for California, United StatesMX-SIN for Sinaloa, Mexico

holiday-api-location-hint

string

required

Locations of the holiday exactly as provided by the Holiday API

timeframe-holiday-begin-time-1

string

required

Beginning of the first time period during which the time frame will take effect on the holiday - format: hhmm

timeframe-holiday-end-time-1

string

required

End of the first time period during which the time frame will take effect on the holiday - format: hhmm

timeframe-holiday-begin-time-2

string

required

Beginning of the second time period, if there is one, during which the time frame will take effect on the holiday - format: hhmm

timeframe-holiday-end-time-2

string

required

End of the second time period, if there is one, during which the time frame will take effect on the holiday - format: hhmm

timeframe-weekly-monday-observance-option

string

required

observe-on-holiday-only: Observe only on the exact holiday
observe-on-holiday-and-next-day: Observe on the exact holiday and the next day
observe-on-holiday-and-prior-day: Observe on the exact holiday and the prior day
observe-on-exact-date-and-next-workday: Observe on the exact holiday and the next workday
observe-on-holiday-and-prior-workday: Observe on the exact holiday and the prior workday
observe-on-next-workday: Observe only on the next workday
observe-on-prior-workday: Observe only on the prior workday

timeframe-weekly-tuesday-observance-option

string

required

timeframe-weekly-wednesday-observance-option

string

required

timeframe-weekly-thursday-observance-option

string

required

timeframe-weekly-friday-observance-option

string

required

timeframe-weekly-saturday-observance-option

string

required

timeframe-weekly-sunday-observance-option

string

required

timeframe-workweek-list

string

required

Comma-separated list containing days of the week to be considered workdays (minimum of 4, maximum of 6).
e.g.: M,T,Th,F,S,Su would produce a workweek of Monday, Tuesday, Thursday, Friday, Saturday, and Sunday

timeframe-recurrence-type

string

required

never: No recurrence.
yearlyOnHoliday: Recurs every year on the holiday.

timeframe-recurrence-end-option

string

required

never: recurs indefinitely.

onDate: ends on the date specified in recurrence_end_date - note: both fields must be set to produce the desired behavior

timeframe-recurrence-end-date

string

required

YYYYMMDD

timeframe-expiry-datetime

string

optional

End date of recurrence - format: YYYYMMDD

timeframe-days-of-week-array

array[object (TimeframeDOW) {36}]

optional

timeframe-id

string

optional

timeframe-weekly-sunday-begin-time-1

string

optional

Beginning of the first time period during which the time frame will take effect on Sundays - format: hhmm

timeframe-weekly-sunday-end-time-1

string

optional

End of the first time period during which the time frame will take effect on Sundays - format: hhmm

timeframe-weekly-sunday-begin-time-2

string

optional

Beginning of the second time period, if there is one, during which the time frame will take effect on Sundays - format: hhmm

timeframe-weekly-sunday-end-time-2

string

optional

End of the second time period, if there is one, during which the time frame will take effect on Sundays - format: hhmm

timeframe-weekly-monday-begin-time-1

string

optional

Beginning of the first time period during which the time frame will take effect on Mondays - format: hhmm

timeframe-weekly-monday-end-time-1

string

optional

End of the first time period during which the time frame will take effect on Mondays - format: hhmm

timeframe-weekly-monday-begin-time-2

string

optional

Beginning of the second time period, if there is one, during which the time frame will take effect on Mondays - format: hhmm

timeframe-weekly-monday-end-time-2

string

optional

End of the second time period, if there is one, during which the time frame will take effect on Mondays - format: hhmm

timeframe-weekly-tuesday-begin-time-1

string

optional

Beginning of the first time period during which the time frame will take effect on Tuesdays - format: hhmm

timeframe-weekly-tuesday-end-time-1

string

optional

End of the first time period during which the time frame will take effect on Tuesdays - format: hhmm

timeframe-weekly-tuesday-begin-time-2

string

optional

Beginning of the second time period, if there is one, during which the time frame will take effect on Tuesdays - format: hhmm

timeframe-weekly-tuesday-end-time-2

string

optional

End of the second time period, if there is one, during which the time frame will take effect on Tuesdays - format: hhmm

timeframe-weekly-wednesday-begin-time-1

string

optional

Beginning of the first time period during which the time frame will take effect on Wednesdays - format: hhmm

timeframe-weekly-wednesday-end-time-1

string

optional

End of the first time period during which the time frame will take effect on Wednesdays - format: hhmm

timeframe-weekly-wednesday-begin-time-2

string

optional

Beginning of the second time period, if there is one, during which the time frame will take effect on Wednesdays - format: hhmm

timeframe-weekly-wednesday-end-time-2

string

optional

End of the second time period, if there is one, during which the time frame will take effect on Wednesdays - format: hhmm

timeframe-weekly-thursday-begin-time-1

string

optional

Beginning of the first time period during which the time frame will take effect on Thursdays - format: hhmm

timeframe-weekly-thursday-end-time-1

string

optional

End of the first time period during which the time frame will take effect on Thursdays - format: hhmm

timeframe-weekly-thursday-begin-time-2

string

optional

Beginning of the second time period, if there is one, during which the time frame will take effect on Thursdays - format: hhmm

timeframe-weekly-thursday-end-time-2

string

optional

End of the second time period, if there is one, during which the time frame will take effect on Thursdays - format: hhmm

timeframe-weekly-friday-begin-time-1

string

optional

Beginning of the first time period during which the time frame will take effect on Fridays - format: hhmm

timeframe-weekly-friday-end-time-1

string

optional

End of the first time period during which the time frame will take effect on Fridays - format: hhmm

timeframe-weekly-friday-begin-time-2

string

optional

Beginning of the second time period, if there is one, during which the time frame will take effect on Fridays - format: hhmm

timeframe-weekly-friday-end-time-2

string

optional

End of the second time period, if there is one, during which the time frame will take effect on Fridays - format: hhmm

timeframe-weekly-saturday-begin-time-1

string

optional

Beginning of the first time period during which the time frame will take effect on Saturdays - format: hhmm

timeframe-weekly-saturday-end-time-1

string

optional

End of the first time period during which the time frame will take effect on Saturdays - format: hhmm

timeframe-weekly-saturday-begin-time-2

string

optional

Beginning of the second time period, if there is one, during which the time frame will take effect on Saturdays - format: hhmm

timeframe-weekly-saturday-end-time-2

string

optional

End of the second time period, if there is one, during which the time frame will take effect on Saturdays - format: hhmm

timeframe-recurrence-type

string

required

weekly: recur every week
custom: if this option is selected the fields timeframe-recurrence-begin-date, timeframe-recurrence-custom-interval, timeframe-recurrence-custom-interval-option, and timeframe-recurrence-custom-interval-count must be set correctly to produce any behavior

timeframe-recurrence-begin-date

string

required

Start date of the recurrence - format: YYYYMMDD - note: this field is only applicable for the timeframe-recurrence-type option custom

timeframe-recurrence-custom-interval

string

required

Must be combined with the field timeframe-recurrence-custom-interval-count

weeks: recur every timeframe-recurrence-custom-interval-count weeks
months: recur every timeframe-recurrence-custom-interval-count months

timeframe-recurrence-custom-interval-count

string

required

Specifies the recurrence count based on the period specified in timeframe-recurrence-custom-interval e.g. 'every 6 weeks' or 'every 3 months'

If the field timeframe-recurrence-custom-interval is set to months this field determines the count in combination with the option set in timeframe-recurrence-custom-interval-option

timeframe-recurrence-custom-interval-option

string

required

If timeframe-recurrence-custom-interval is set to weeks this field is not used. This field is for months only.
The following options configure recurrence for the Days of Week period according to the start date defined in timeframe-recurrence-begin-date.

For timeframe-recurrence-custom-interval of months:
monthly-same-day: recur on the same day of the month, e.g.: the 14th day, the 29th day - note: if there are months in which the “day” does not occur, the Days fo Week will not be active during that month, e.g.: the 31st day of February
monthly-ordinal-weekday: recur on any ordinal weekday in the given month e.g. the third Friday, the second Monday
monthly-first-last-weekday: recur on the first or last instance of the selected weekday in the month, e.g.: the first Wednesday, the last Tuesday - note: this will produce potentially unexpected behavior if used with a date that is not the first or last occurrence of that particular weekday

timeframe-recurrence-end-option

string

required

never: recurrence will continue indefinitely
onADate: recurrence will end on a date, specified in timeframe-recurrence-end-date

timeframe-recurrence-end-date

string

required

End date of the recurrence - format: YYYYMMDD

Example

{
    "update-only": "string",
    "timeframe-specific-dates-array": [
        {
            "timeframe-id": "string",
            "timeframe-specific-dates-begin-date": "string",
            "timeframe-specific-dates-begin-time": "string",
            "timeframe-specific-dates-end-date": "string",
            "timeframe-specific-dates-end-time": "string",
            "timeframe-recurrence-type": "string",
            "timeframe-recurrence-custom-interval": "string",
            "timeframe-recurrence-custom-interval-count": "string",
            "timeframe-recurrence-custom-interval-option": "string",
            "timeframe-recurrence-end-option": "string",
            "timeframe-recurrence-end-date": "string"
        }
    ],
    "timeframe-holiday-array": [
        {
            "timeframe-id": "string",
            "timeframe-holiday-uuid": "string",
            "timeframe-holiday-name": "string",
            "timeframe-holiday-begin-date": "string",
            "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": "string",
            "timeframe-expiry-datetime": "string"
        }
    ],
    "timeframe-days-of-week-array": [
        {
            "timeframe-id": "string",
            "timeframe-weekly-sunday-begin-time-1": "string",
            "timeframe-weekly-sunday-end-time-1": "string",
            "timeframe-weekly-sunday-begin-time-2": "string",
            "timeframe-weekly-sunday-end-time-2": "string",
            "timeframe-weekly-monday-begin-time-1": "string",
            "timeframe-weekly-monday-end-time-1": "string",
            "timeframe-weekly-monday-begin-time-2": "string",
            "timeframe-weekly-monday-end-time-2": "string",
            "timeframe-weekly-tuesday-begin-time-1": "string",
            "timeframe-weekly-tuesday-end-time-1": "string",
            "timeframe-weekly-tuesday-begin-time-2": "string",
            "timeframe-weekly-tuesday-end-time-2": "string",
            "timeframe-weekly-wednesday-begin-time-1": "string",
            "timeframe-weekly-wednesday-end-time-1": "string",
            "timeframe-weekly-wednesday-begin-time-2": "string",
            "timeframe-weekly-wednesday-end-time-2": "string",
            "timeframe-weekly-thursday-begin-time-1": "string",
            "timeframe-weekly-thursday-end-time-1": "string",
            "timeframe-weekly-thursday-begin-time-2": "string",
            "timeframe-weekly-thursday-end-time-2": "string",
            "timeframe-weekly-friday-begin-time-1": "string",
            "timeframe-weekly-friday-end-time-1": "string",
            "timeframe-weekly-friday-begin-time-2": "string",
            "timeframe-weekly-friday-end-time-2": "string",
            "timeframe-weekly-saturday-begin-time-1": "string",
            "timeframe-weekly-saturday-end-time-1": "string",
            "timeframe-weekly-saturday-begin-time-2": "string",
            "timeframe-weekly-saturday-end-time-2": "string",
            "timeframe-recurrence-type": "string",
            "timeframe-recurrence-begin-date": "string",
            "timeframe-recurrence-custom-interval": "string",
            "timeframe-recurrence-custom-interval-count": "string",
            "timeframe-recurrence-custom-interval-option": "string",
            "timeframe-recurrence-end-option": "string",
            "timeframe-recurrence-end-date": "string"
        }
    ]
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location -g --request PUT 'https://awqacore01.crexendocloud.com/ns-api/v2/domains/{{domain}}/users/{{user}}/timeframes/HASHHACK5' \
--header 'Content-Type: application/json' \
--data-raw '{
    "update-only": "string",
    "timeframe-specific-dates-array": [
        {
            "timeframe-id": "string",
            "timeframe-specific-dates-begin-date": "string",
            "timeframe-specific-dates-begin-time": "string",
            "timeframe-specific-dates-end-date": "string",
            "timeframe-specific-dates-end-time": "string",
            "timeframe-recurrence-type": "string",
            "timeframe-recurrence-custom-interval": "string",
            "timeframe-recurrence-custom-interval-count": "string",
            "timeframe-recurrence-custom-interval-option": "string",
            "timeframe-recurrence-end-option": "string",
            "timeframe-recurrence-end-date": "string"
        }
    ],
    "timeframe-holiday-array": [
        {
            "timeframe-id": "string",
            "timeframe-holiday-uuid": "string",
            "timeframe-holiday-name": "string",
            "timeframe-holiday-begin-date": "string",
            "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": "string",
            "timeframe-expiry-datetime": "string"
        }
    ],
    "timeframe-days-of-week-array": [
        {
            "timeframe-id": "string",
            "timeframe-weekly-sunday-begin-time-1": "string",
            "timeframe-weekly-sunday-end-time-1": "string",
            "timeframe-weekly-sunday-begin-time-2": "string",
            "timeframe-weekly-sunday-end-time-2": "string",
            "timeframe-weekly-monday-begin-time-1": "string",
            "timeframe-weekly-monday-end-time-1": "string",
            "timeframe-weekly-monday-begin-time-2": "string",
            "timeframe-weekly-monday-end-time-2": "string",
            "timeframe-weekly-tuesday-begin-time-1": "string",
            "timeframe-weekly-tuesday-end-time-1": "string",
            "timeframe-weekly-tuesday-begin-time-2": "string",
            "timeframe-weekly-tuesday-end-time-2": "string",
            "timeframe-weekly-wednesday-begin-time-1": "string",
            "timeframe-weekly-wednesday-end-time-1": "string",
            "timeframe-weekly-wednesday-begin-time-2": "string",
            "timeframe-weekly-wednesday-end-time-2": "string",
            "timeframe-weekly-thursday-begin-time-1": "string",
            "timeframe-weekly-thursday-end-time-1": "string",
            "timeframe-weekly-thursday-begin-time-2": "string",
            "timeframe-weekly-thursday-end-time-2": "string",
            "timeframe-weekly-friday-begin-time-1": "string",
            "timeframe-weekly-friday-end-time-1": "string",
            "timeframe-weekly-friday-begin-time-2": "string",
            "timeframe-weekly-friday-end-time-2": "string",
            "timeframe-weekly-saturday-begin-time-1": "string",
            "timeframe-weekly-saturday-end-time-1": "string",
            "timeframe-weekly-saturday-begin-time-2": "string",
            "timeframe-weekly-saturday-end-time-2": "string",
            "timeframe-recurrence-type": "string",
            "timeframe-recurrence-begin-date": "string",
            "timeframe-recurrence-custom-interval": "string",
            "timeframe-recurrence-custom-interval-count": "string",
            "timeframe-recurrence-custom-interval-option": "string",
            "timeframe-recurrence-end-option": "string",
            "timeframe-recurrence-end-date": "string"
        }
    ]
}'

Responses

🟢200OK

application/json

Body

object {0}

Example

{}

🟠404Record not found

🟠400Bad Request

🟠401Authentication Required

Modified at 2025-03-27 00:15:56

Create Additional Entries within Custom Timeframe

Replace All Entries in Custom Timeframe