openapi: 3.0.0
info:
title: 'Webex Admin Address Book Location Call Settings: Schedules API'
version: 1.0.0
description: The Webex Admin APIs provide comprehensive programmatic access to administrative functions for managing Webex organizations, users, licenses, and settings. These APIs enable automation of user provisioning, license assignment, compliance management, and audit event retrieval. Administrators can integrate with enterprise identity systems, enforce security policies, monitor usage, and streamline onboarding/offboarding processes. The APIs support granular control over organizational resources, making them ideal for large-scale deployments and custom admin tooling.
tags:
- name: 'Location Call Settings: Schedules'
paths:
/telephony/config/locations/{locationId}/schedules:
get:
responses:
'200':
description: OK
headers:
Link:
schema:
type: string
content:
application/json:
schema:
type: object
required:
- schedules
properties:
schedules:
type: array
items:
$ref: '#/components/schemas/ListScheduleObject'
description: Array of schedules.
example:
schedules:
- id: Y2lzY29zcGFyazovL3VzL1NDSEVEVUxFL1FWVlVUMEZVVkVWT1JFRk9WQzFDVlZOSlRrVlRVeTFJVDFWU1V3
name: AUTOATTENDANT-BUSINESS-HOURS
type: businessHours
locationName: Alaska
locationId: Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzMxMTYx
- id: Y2lzY29zcGFyazovL3VzL1NDSEVEVUxFL1FWVlVUMEZVVkVWT1JFRk9WQzFJVDB4SlJFRlo
name: AUTOATTENDANT-HOLIDAY
type: holidays
locationName: Alaska
locationId: Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzMxMTYx
'400':
description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.'
'401':
description: 'Unauthorized: Authentication credentials were missing or incorrect.'
'403':
description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.'
'404':
description: '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':
description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.'
'409':
description: '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':
description: 'Gone: The requested resource is no longer available.'
'415':
description: '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':
description: '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':
description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.'
'429':
description: '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':
description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).'
'502':
description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.'
'503':
description: 'Service Unavailable: Server is overloaded with requests. Try again later.'
'504':
description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.'
summary: Read the List of Schedules
operationId: Read the List of Schedules
description: 'List all schedules for the given location of the organization.
A time schedule establishes a set of times during the day or holidays in the year in which a feature, for example auto attendants, can perform a specific action.
Retrieving this list requires a full or read-only administrator or location administrator auth token with a scope of `spark-admin:telephony_config_read`.'
tags:
- 'Location Call Settings: Schedules'
parameters:
- name: locationId
in: path
description: Return the list of schedules for this location.
required: true
example: Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzMxMTYx
schema:
type: string
- name: orgId
in: query
description: List schedules for this organization.
example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE
schema:
type: string
- name: max
in: query
description: Limit the number of objects returned to this maximum count.
example: '5'
schema:
type: number
- name: start
in: query
description: Start at the zero-based offset in the list of matching objects.
example: '0'
schema:
type: number
- name: name
in: query
description: Only return schedules with the matching name.
example: AUTOATTENDANT-BUSINESS-HOURS
schema:
type: string
- name: type
in: query
description: Type of the schedule.
example: businessHours
schema:
type: string
enum:
- businessHours
- holidays
post:
responses:
'201':
description: Created
headers: {}
content:
application/json:
schema:
type: object
required:
- id
properties:
id:
type: string
description: ID of the newly created schedule.
example:
id: Y2lzY29zcGFyazovL3VzL1NDSEVEVUxFL1FWVlVUMEZVVkVWT1JFRk9WQzFDVlZOSlRrVlRVeTFJVDFWU1V3
'400':
description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.'
'401':
description: 'Unauthorized: Authentication credentials were missing or incorrect.'
'403':
description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.'
'404':
description: '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':
description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.'
'409':
description: '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':
description: 'Gone: The requested resource is no longer available.'
'415':
description: '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':
description: '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':
description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.'
'429':
description: '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':
description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).'
'502':
description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.'
'503':
description: 'Service Unavailable: Server is overloaded with requests. Try again later.'
'504':
description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.'
summary: Create a Schedule
operationId: Create a Schedule
description: 'Create new Schedule for the given location.
A time schedule establishes a set of times during the day or holidays in the year in which a feature, for example auto attendants, can perform a specific action.
Creating a schedule requires a full administrator or location administrator auth token with a scope of `spark-admin:telephony_config_write`.'
tags:
- 'Location Call Settings: Schedules'
parameters:
- name: locationId
in: path
description: Create the schedule for this location.
required: true
example: Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzEyMzQ1
schema:
type: string
- name: orgId
in: query
description: Create the schedule for this organization.
example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE
schema:
type: string
requestBody:
content:
application/json:
example:
name: AUTOATTENDANT-BUSINESS-HOURS
type: businessHours
events:
- name: Monday 1
startDate: '2021-11-03'
endDate: '2021-11-03'
startTime: 09:00
endTime: '11:00'
allDayEnabled: false
recurrence:
recurWeekly:
sunday: false
monday: true
tuesday: false
wednesday: false
thursday: false
friday: false
saturday: false
- name: Monday 2
startDate: '2021-11-03'
endDate: '2021-11-03'
startTime: '12:00'
endTime: '17:00'
allDayEnabled: false
recurrence:
recurWeekly:
sunday: false
monday: true
tuesday: false
wednesday: false
thursday: false
friday: false
saturday: false
- name: Tuesday 1
startDate: '2021-11-03'
endDate: '2021-11-03'
startTime: 09:00
endTime: '11:00'
allDayEnabled: false
recurrence:
recurWeekly:
sunday: false
monday: false
tuesday: true
wednesday: false
thursday: false
friday: false
saturday: false
- name: Tuesday 2
startDate: '2021-11-03'
endDate: '2021-11-03'
startTime: '12:00'
endTime: '17:00'
allDayEnabled: false
recurrence:
recurWeekly:
sunday: false
monday: false
tuesday: true
wednesday: false
thursday: false
friday: false
saturday: false
- name: Wednesday 1
startDate: '2021-11-03'
endDate: '2021-11-03'
startTime: 09:00
endTime: '11:00'
allDayEnabled: false
recurrence:
recurWeekly:
sunday: false
monday: false
tuesday: false
wednesday: true
thursday: false
friday: false
saturday: false
- name: Wednesday 2
startDate: '2021-11-03'
endDate: '2021-11-03'
startTime: '12:00'
endTime: '17:00'
allDayEnabled: false
recurrence:
recurWeekly:
sunday: false
monday: false
tuesday: false
wednesday: true
thursday: false
friday: false
saturday: false
- name: Thursday 1
startDate: '2021-11-03'
endDate: '2021-11-03'
startTime: 09:00
endTime: '11:00'
allDayEnabled: false
recurrence:
recurWeekly:
sunday: false
monday: false
tuesday: false
wednesday: false
thursday: true
friday: false
saturday: false
- name: Thursday 2
startDate: '2021-11-03'
endDate: '2021-11-03'
startTime: '12:00'
endTime: '17:00'
allDayEnabled: false
recurrence:
recurWeekly:
sunday: false
monday: false
tuesday: false
wednesday: false
thursday: true
friday: false
saturday: false
- name: Friday 1
startDate: '2021-11-03'
endDate: '2021-11-03'
startTime: 09:00
endTime: '11:00'
allDayEnabled: false
recurrence:
recurWeekly:
sunday: false
monday: false
tuesday: false
wednesday: false
thursday: false
friday: true
saturday: false
- name: Friday 2
startDate: '2021-11-03'
endDate: '2021-11-03'
startTime: '12:00'
endTime: '17:00'
allDayEnabled: false
recurrence:
recurWeekly:
sunday: false
monday: false
tuesday: false
wednesday: false
thursday: false
friday: true
saturday: false
schema:
$ref: '#/components/schemas/PostScheduleObject'
/telephony/config/locations/{locationId}/schedules/{type}/{scheduleId}:
get:
responses:
'200':
description: OK
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/GetScheduleObject'
example:
id: Y2lzY29zcGFyazovL3VzL1NDSEVEVUxFL1FWVlVUMEZVVkVWT1JFRk9WQzFJVDB4SlJFRlo
name: AUTOATTENDANT-HOLIDAY
type: holidays
events:
- id: Y2lzY29zcGFyazovL3VzL1NDSEVEVUxFX0VWRU5UL1RtVjNJRmxsWVhJbmN5QkVZWGs
name: New Year's Day
startDate: '2022-01-01'
endDate: '2022-01-01'
allDayEnabled: true
recurrence:
recurForEver: true
recurYearlyByDate:
dayOfMonth: 1
month: JANUARY
'400':
description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.'
'401':
description: 'Unauthorized: Authentication credentials were missing or incorrect.'
'403':
description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.'
'404':
description: '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':
description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.'
'409':
description: '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':
description: 'Gone: The requested resource is no longer available.'
'415':
description: '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':
description: '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':
description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.'
'429':
description: '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':
description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).'
'502':
description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.'
'503':
description: 'Service Unavailable: Server is overloaded with requests. Try again later.'
'504':
description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.'
summary: Get Details for a Schedule
operationId: Get Details for a Schedule
description: 'Retrieve Schedule details.
A time schedule establishes a set of times during the day or holidays in the year in which a feature, for example auto attendants, can perform a specific action.
Retrieving schedule details requires a full or read-only administrator or location administrator auth token with a scope of `spark-admin:telephony_config_read`.'
tags:
- 'Location Call Settings: Schedules'
parameters:
- name: locationId
in: path
description: Retrieve schedule details in this location.
required: true
example: Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzEyMzQ1
schema:
type: string
- name: type
in: path
description: Type of the schedule.
required: true
example: businessHours
schema:
type: string
enum:
- businessHours
- holidays
- name: scheduleId
in: path
description: Retrieve the schedule with the matching ID.
required: true
example: Y2lzY29zcGFyazovL3VzL1NDSEVEVUxFL1FWVlVUMEZVVkVWT1JFRk9WQzFJVDB4SlJFRlo
schema:
type: string
- name: orgId
in: query
description: Retrieve schedule details from this organization.
example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE
schema:
type: string
put:
responses:
'200':
description: OK
headers: {}
content:
application/json:
schema:
type: object
required:
- id
properties:
id:
type: string
description: ID of the target schedule.
example:
id: Y2lzY29zcGFyazovL3VzL1NDSEVEVUxFL1RrVlhMVmxGUVZJdFNFOU1TVVJCV1E
'400':
description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.'
'401':
description: 'Unauthorized: Authentication credentials were missing or incorrect.'
'403':
description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.'
'404':
description: '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':
description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.'
'409':
description: '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':
description: 'Gone: The requested resource is no longer available.'
'415':
description: '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':
description: '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':
description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.'
'429':
description: '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':
description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).'
'502':
description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.'
'503':
description: 'Service Unavailable: Server is overloaded with requests. Try again later.'
'504':
description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.'
summary: Update a Schedule
operationId: Update a Schedule
description: 'Update the designated schedule.
A time schedule establishes a set of times during the day or holidays in the year in which a feature, for example auto attendants, can perform a specific action.
Updating a schedule requires a full administrator or location administrator auth token with a scope of `spark-admin:telephony_config_write`.
**NOTE**: The Schedule ID will change upon modification of the Schedule name.'
tags:
- 'Location Call Settings: Schedules'
parameters:
- name: locationId
in: path
description: Location in which this schedule exists.
required: true
example: Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzEyMzQ1
schema:
type: string
- name: type
in: path
description: Type of schedule.
required: true
example: businessHours
schema:
type: string
enum:
- businessHours
- holidays
- name: scheduleId
in: path
description: Update schedule with the matching ID.
required: true
example: Y2lzY29zcGFyazovL3VzL1NDSEVEVUxFL1FWVlVUMEZVVkVWT1JFRk9WQzFJVDB4SlJFRlo
schema:
type: string
- name: orgId
in: query
description: Update schedule from this organization.
example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE
schema:
type: string
requestBody:
content:
application/json:
example:
name: NEW-YEAR-HOLIDAY
events:
- name: New Year
newName: New Year's Day
startDate: '2022-01-01'
endDate: '2022-01-01'
allDayEnabled: true
recurrence:
recurForEver: true
recurYearlyByDate:
dayOfMonth: 1
month: JANUARY
schema:
$ref: '#/components/schemas/ModifyScheduleObject'
delete:
responses:
'204':
description: No Content
headers: {}
content: {}
'400':
description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.'
'401':
description: 'Unauthorized: Authentication credentials were missing or incorrect.'
'403':
description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.'
'404':
description: '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':
description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.'
'409':
description: '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':
description: 'Gone: The requested resource is no longer available.'
'415':
description: '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':
description: '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':
description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.'
'429':
description: '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':
description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).'
'502':
description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.'
'503':
description: 'Service Unavailable: Server is overloaded with requests. Try again later.'
'504':
description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.'
summary: Delete a Schedule
operationId: Delete a Schedule
description: 'Delete the designated Schedule.
A time schedule establishes a set of times during the day or holidays in the year in which a feature, for example auto attendants, can perform a specific action.
Deleting a schedule requires a full administrator or location administrator auth token with a scope of `spark-admin:telephony_config_write`.'
tags:
- 'Location Call Settings: Schedules'
parameters:
- name: locationId
in: path
description: Location from which to delete a schedule.
required: true
example: Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzEyMzQ1
schema:
type: string
- name: type
in: path
description: Type of the schedule.
required: true
example: businessHours
schema:
type: string
enum:
- businessHours
- holidays
- name: scheduleId
in: path
description: Delete the schedule with the matching ID.
required: true
example: Y2lzY29zcGFyazovL3VzL1NDSEVEVUxFL1FWVlVUMEZVVkVWT1JFRk9WQzFJVDB4SlJFRlo
schema:
type: string
- name: orgId
in: query
description: Delete the schedule from this organization.
example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE
schema:
type: string
/telephony/config/locations/{locationId}/schedules/{type}/{scheduleId}/events/{eventId}:
get:
responses:
'200':
description: OK
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/GetScheduleEventObject'
example:
id: Y2lzY29zcGFyazovL3VzL1NDSEVEVUxFX0VWRU5UL1RtVjNJRmxsWVhJbmN3
name: New Year's
startDate: '2022-01-01'
endDate: '2022-01-01'
allDayEnabled: true
recurrence:
recurForEver: true
recurYearlyByDate:
dayOfMonth: 1
month: JANUARY
'400':
description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.'
'401':
description: 'Unauthorized: Authentication credentials were missing or incorrect.'
'403':
description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.'
'404':
description: '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':
description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.'
'409':
description: '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':
description: 'Gone: The requested resource is no longer available.'
'415':
description: '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':
description: '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':
description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.'
'429':
description: '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':
descriptio
# --- truncated at 32 KB (61 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/webex/refs/heads/main/openapi/webex-location-call-settings-schedules-api-openapi.yml