Create an Operating Mode Holiday.
Create a holiday schedule event for the designated Operating Mode.
Holidays define a recurring schedule for the Operating Modes. An Operating Mode can have a max of 150 holidays.
Creating an Operating Mode Holiday requires a full, or location administrator auth token with a scope of spark-admin:telephony_config_write.
POST/v1/telephony/config/operatingModes/{modeId}/holidays
URI Parameters
modeId
stringrequired
Create the holiday for this operating mode.
Query Parameters
orgId
string
Create the operating mode holiday for this organization.
Body Parameters
name
stringrequired
Name of the holiday.
allDayEnabled
booleanrequired
Specifies if the operating mode holiday schedule event is enabled for the entire day. False if the flag is not set.
startDate
stringrequired
Start date of the operating mode holiday.
endDate
stringrequired
End date of the operating mode holiday.
startTime
string
Start time for the operating mode holiday. Mandatory if allDayEnabled is false.
endTime
string
End time for the operating mode holiday. Mandatory if allDayEnabled is false.
recurrence
OperatingModeRecurrenceObject
Recurrence configuration for the operating mode holiday.
recurYearlyByDate
RecurYearlyByDateObject
Recurrence definition yearly by date.
dayOfMonth
numberrequired
Schedule the event on a specific day of the month.
month
enumrequired
Schedule the event on a specific month of the year.
`JANUARY`: Schedule the event in January.
string
`FEBRUARY`: Schedule the event in February.
string
`MARCH`: Schedule the event in March.
string
`APRIL`: Schedule the event in April.
string
`MAY`: Schedule the event in May.
string
`JUNE`: Schedule the event in June.
string
`JULY`: Schedule the event in July.
string
`AUGUST`: Schedule the event in August.
string
`SEPTEMBER`: Schedule the event in September.
string
`OCTOBER`: Schedule the event in October.
string
`NOVEMBER`: Schedule the event in November.
string
`DECEMBER`: Schedule the event in December.
string
recurYearlyByDay
RecurYearlyByDayObject
Recurrence definition yearly by day.
day
enumrequired
Schedule the event on a specific day.
`SUNDAY`: Schedule the event on Sunday.
string
`MONDAY`: Schedule the event on Monday.
string
`TUESDAY`: Schedule the event on Tuesday.
string
`WEDNESDAY`: Schedule the event on Wednesday.
string
`THURSDAY`: Schedule the event on Thursday.
string
`FRIDAY`: Schedule the event on Friday.
string
`SATURDAY`: Schedule the event on Saturday.
string
week
enumrequired
Schedule the event on a specific week.
`FIRST`: Schedule the event on the first week of the month.
string
`SECOND`: Schedule the event on the second week of the month.
string
`THIRD`: Schedule the event on the third week of the month.
string
`FOURTH`: Schedule the event on the fourth week of the month.
string
`LAST`: Schedule the event on the last week of the month.
string
month
enumrequired
Schedule the event on a specific month.
`JANUARY`: Schedule the event in January.
string
`FEBRUARY`: Schedule the event in February.
string
`MARCH`: Schedule the event in March.
string
`APRIL`: Schedule the event in April.
string
`MAY`: Schedule the event in May.
string
`JUNE`: Schedule the event in June.
string
`JULY`: Schedule the event in July.
string
`AUGUST`: Schedule the event in August.
string
`SEPTEMBER`: Schedule the event in September.
string
`OCTOBER`: Schedule the event in October.
string
`NOVEMBER`: Schedule the event in November.
string
`DECEMBER`: Schedule the event in December.
string
Response Properties
id
string
ID of the newly created holiday.
Response Codes
The list below describes the common success and error responses you should expect from the API:
| Code | Status | Description |
|---|---|---|
| 200 | OK | Successful request with body content. |
| 201 | Created | The request has succeeded and has led to the creation of a resource. |
| 202 | Accepted | The request has been accepted for processing. |
| 204 | No Content | Successful request without body content. |
| 400 | Bad Request | The request was invalid or cannot be otherwise served. An accompanying error message will explain further. |
| 401 | Unauthorized | Authentication credentials were missing or incorrect. |
| 403 | Forbidden | The request is understood, but it has been refused or access is not allowed. |
| 404 | Not Found | The URI requested is invalid or the resource requested, such as a user, does not exist. Also returned when the requested format is not supported by the requested method. |
| 405 | Method Not Allowed | The request was made to a resource using an HTTP request method that is not supported. |
| 409 | Conflict | The request could not be processed because it conflicts with some established rule of the system. For example, a person may not be added to a room more than once. |
| 410 | Gone | The requested resource is no longer available. |
| 415 | Unsupported Media Type | The request was made to a resource without specifying a media type or used a media type that is not supported. |
| 423 | Locked | The requested resource is temporarily unavailable. A Retry-After header may be present that specifies how many seconds you need to wait before attempting the request again. |
| 428 | Precondition Required | File(s) cannot be scanned for malware and need to be force downloaded. |
| 429 | Too Many Requests | Too many requests have been sent in a given amount of time and the request has been rate limited. A Retry-After header should be present that specifies how many seconds you need to wait before a successful request can be made. |
| 500 | Internal Server Error | Something went wrong on the server. If the issue persists, feel free to contact the Webex Developer Support team. |
| 502 | Bad Gateway | The server received an invalid response from an upstream server while processing the request. Try again later. |
| 503 | Service Unavailable | Server is overloaded with requests. Try again later. |
| 504 | Gateway Timeout | An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it. |
POST
/v1/telephony/config/operatingModes//holidays{?orgId}
Log in to try the API.
Header
Query Parameters
- Create the `operating mode holiday` for this organization.
Body
- Name of the holiday.
- Specifies if the `operating mode holiday` schedule event is enabled for the entire day. `False` if the flag is not set.
- Start date of the `operating mode holiday`.
- End date of the `operating mode holiday`.
- Start time for the `operating mode holiday`. Mandatory if `allDayEnabled` is false.
- End time for the `operating mode holiday`. Mandatory if `allDayEnabled` is false.
- Recurrence configuration for the `operating mode holiday`.
https://webexapis.com/v1/telephony/config/operatingModes/Y2lzY29zcGFyazovL3VzL09QRVJBVElOR19NT0RFL2JiOTc1OTcxLTBjZWYtNDdhNi05Yzc5LTliZWFjY2IwYjg4Mg/holidays?orgId=Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE
{
"name": "Christmas",
"allDayEnabled": true,
"startDate": "2024-12-25",
"endDate": "2024-12-26",
"startTime": "09:00",
"endTime": "17:00",
"recurrence": {
"recurYearlyByDay": {
"day": "TUESDAY",
"week": "FIRST",
"month": "JANUARY"
}
}
}
201 / Created
{
"id": "Y2lzY29zcGFyazovL3VzL1NDSEVEVUxFX0VWRU5UL2E4Mjg5NzIyLTFiODAtNDFiNy05Njc4LTBlNzdhZThjMTIwOQ"
}