Update Date Ranges within Specific Dates Timeframe

PUT

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

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

In order to update date ranges within a Specific Dates timeframe, include the parameter update_only and provide within the array timeframe-specific-dates-array the new values for the date ranges you intend to update, including in each date range the associated timeframe-id for that range. If any date ranges 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 Date Ranges in Specific Dates 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

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"
    }
  ]
}

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/HASHHACK1' \
--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"
        }
    ]
}'

Responses

🟢200OK

application/json

Body

object {0}

Example

{}

🟠404Record not found

🟠400Bad Request

🟠401Authentication Required

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

Replace All Date Ranges in Specific Dates Timeframe

Delete Date Range within Specific Dates Timeframe