APIs
XML API DeprecationGetting StartedREST API BasicsComplianceWebhooksWebex APIs
Admin
OverviewAdmin APIsAuthentication
Guides
Reference
Admin Audit EventsAuthorizationsEventsGroupsHistorical AnalyticsHybrid ClustersHybrid ConnectorsLicensesLocationsMeeting QualitiesMembershipsOrganizationsPeopleRecording ReportRecordingsReport TemplatesReportsResource Group MembershipsResource GroupsRolesSpace ClassificationsWebex Calling Organization SettingsWebex Calling Person Settings
Workspace LocationsWorkspace MetricsWorkspaces
Calling
Overview
Guides
Reference
BroadWorks Device ProvisioningBroadWorks EnterprisesBroadWorks SubscribersCall ControlsLocationsPeopleRecording ReportWebex Calling Organization SettingsWebex Calling Organization Settings with NumbersWebex Calling Person Settings
Webex Calling Voice MessagingWebex Calling Workspace Settings with NumbersWholesale CustomersWholesale Subscribers
Devices
Meetings
Messaging
Webex Assistant Skills
FedRAMP
Full API Reference
Admin Audit EventsAttachment ActionsAuthorizationsBroadWorks Device ProvisioningBroadWorks EnterprisesBroadWorks SubscribersCall ControlsDevice ConfigurationsDevicesEventsGroupsHistorical AnalyticsHybrid ClustersHybrid ConnectorsLicensesLocationsMeeting ChatsMeeting InviteesMeeting ParticipantsMeeting PreferencesMeeting QualitiesMeeting TranscriptsMeetingsMembershipsMessagesOrganizationsPeoplePlacesRecording ReportRecordingsReport TemplatesReportsResource Group MembershipsResource GroupsRolesRoom TabsRoomsSpace ClassificationsTeam MembershipsTeamsWebex Calling Organization SettingsWebex Calling Organization Settings with NumbersWebex Calling Person Settings
Webex Calling Voice MessagingWebex Calling Workspace Settings with NumbersWebhooksWholesale CustomersWholesale SubscribersWorkspace LocationsWorkspace MetricsWorkspace PersonalizationWorkspacesxAPI
API Changelog

Update a Schedule

Modify a schedule by its schedule id.

Schedules are used to support calling features and can be defined at the location or person level. businessHours schedules allow you to apply specific call settings at different times of the day or week by defining one or more events. holidays schedules define exceptions to normal business hours by defining one or more events.

This API requires a full or user administrator auth token with the spark-admin:people_write scope.

PUT/v1/people/{personId}/features/schedules/{scheduleType}/{scheduleId}
URI Parameters
personId
stringrequired

Unique identifier for the person.

scheduleType
ScheduleTyperequired

Type of schedule, either businessHours or holidays.

scheduleId
stringrequired

Unique identifier for the schedule.

Query Parameters
orgId
string

Person is in this organization. Only admin users of another organization (such as partners) may use this parameter as the default is the same organization as the token used to access API.

Body Parameters
newName
stringrequired

New name for the schedule.

name
stringrequired

Name for the schedule.

type
ScheduleTyperequired

Indicates the schedule type whether businessHours or holidays.

businessHours
string

Indicates the schedule type that specifies the business or working hours during the day.

holidays
string

Indicates the schedule type that specifies the day when your organization is not open.

events
array[EventLongDetails]

Indicates a list of events.

name
stringrequired

Name for the event.

startDate
stringrequired

Start date of the event, or first occurrence if repeating, in the format of YYYY-MM-DD. This field is required if allDayEnabled field is present.

endDate
stringrequired

End date of the event, or first occurrence if repeating, in the format of YYYY-MM-DD. This field is required if allDayEnabled field is present.

startTime
stringrequired

Start time of the event in the format of HH:MM (24 hours format). This field is required if allDayEnabled field is false or omitted.

endTime
stringrequired

End time of the event in the format of HH:MM (24 hours format). This field is required if allDayEnabled field is false or omitted.

allDayEnabled
boolean

True if it is all-day event.

recurrence
object

Recurrance scheme for an event.

recurForEver
boolean

True if the event repeats forever. Requires either recurDaily or recurWeekly to be specified.

recurEndDate
string

End date for the recurring event in the format of YYYY-MM-DD. Requires either recurDaily or recurWeekly to be specified.

recurEndOccurrence
number

End recurrence after the event has repeated the specified number of times. Requires either recurDaily or recurWeekly to be specified.

recurDaily
object

Specifies the number of days between the start of each recurrence and is not allowed with recurWeekly.

recurInterval
numberrequired

Recurring interval in Daily. The Number of days after the start when an event will repeat. Repetitions cannot overlap.

recurWeekly
object

Specifies the event recur weekly on the designated days of the week and is not allowed with recurDaily.

recurInterval
numberrequired

Specifies the number of weeks between the start of each recurrence.

sunday
boolean

Indicates event occurs weekly on Sunday.

monday
boolean

Indicates event occurs weekly on Monday.

tuesday
boolean

Indicates event occurs weekly on Tuesday.

wednesday
boolean

Indicates event occurs weekly on Wednesday.

thursday
boolean

Indicates event occurs weekly on Thursday.

friday
boolean

Indicates event occurs weekly on Friday.

saturday
boolean

Indicates event occurs weekly on Saturday.

Response Properties
id
string

Identifier for a schedule.

Response Codes

The list below describes the common success and error responses you should expect from the API.

CodeStatusDescription
200OKSuccessful request with body content.
204No ContentSuccessful request without body content.
400Bad RequestThe request was invalid or cannot be otherwise served. An accompanying error message will explain further.
401UnauthorizedAuthentication credentials were missing or incorrect.
403ForbiddenThe request is understood, but it has been refused or access is not allowed.
404Not FoundThe 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.
405Method Not AllowedThe request was made to a resource using an HTTP request method that is not supported.
409ConflictThe 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.
410GoneThe requested resource is no longer available.
415Unsupported Media TypeThe request was made to a resource without specifying a media type or used a media type that is not supported.
423LockedThe 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.
428Precondition RequiredFile(s) cannot be scanned for malware and need to be force downloaded.
429Too Many RequestsToo 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.
500Internal Server ErrorSomething went wrong on the server. If the issue persists, feel free to contact the Webex Developer Support team.
502Bad GatewayThe server received an invalid response from an upstream server while processing the request. Try again later.
503Service UnavailableServer is overloaded with requests. Try again later.
504Gateway TimeoutAn upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.
PUT
/v1/people//features/schedules//{?orgId}
Log in to try the API.
Header
Query Parameters
  • Person is in this organization. Only admin users of another organization (such as partners) may use this parameter as the default is the same organization as the token used to access API.
Body
  • New name for the schedule.
  • Name for the schedule.
  • Indicates the schedule type whether `businessHours` or `holidays`.
  • Indicates a list of events.
https://webexapis.com/v1/people/Y2lzY29zcGFyazovL3VzL1BFT1BMRS8xMWEzZjk5MC1hNjg5LTQ3N2QtYmU2Yi03MTIwMDI1ZDhhYmI/features/schedules/undefined/Y2lzY29zcGFyazovL3VzL1VTRVJfU0NIRURVTEUvUkdGc2JHRnpYMDltWm1salpWOUliM1Z5Y3c9PQ?orgId=Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE
{
  "newName": "Richardson_Office_Hours",
  "name": "Dallas_Office_Hours",
  "type": null,
  "events": [
    {
      "name": "Day_Shift","startDate": "2020-03-18","endDate": "2020-03-18","startTime": "08:00","endTime": "17:00","allDayEnabled": false,
      "recurrence": {
        [object Object],
        [object Object],
        [object Object],
        [object Object],
        [object Object]
      }    
    }
  ]
}
200 / OK
{
  "id": "Y2lzY29zcGFyazovL3VzL1VTRVJfU0NIRURVTEUvVW1samFHRnlaSE52Ymw5UFptWnBZMlZmU0c5MWNuTT0"
}