DocumentationBlogSupport
Log inSign up
Log inSign up
BlogSupport
Build
Getting StartedPlatform Introduction
Embedded Apps
OverviewDeveloper GuideSubmission Checklist for Embedded Apps
Design Guidelines
MeetingsMessagingDevices
API Reference
BotsButtons and CardsIntegrationsLogin with WebexWidgetsGuest IssuerWebex ConnectInstant Connect Meeting LinksDeveloper SandboxSubmit Your AppSupport PolicyFAQs
APIs
XML API DeprecationGetting StartedREST API BasicsComplianceWebhooksWebex APIs
Admin
OverviewAdmin APIsAuthentication
Guides
Hybrid ServicesWebhooksReal-time File DLP Basics
Reference
Admin Audit EventsAuthorizationsEventsGroupsHistorical AnalyticsHybrid ClustersHybrid ConnectorsLicensesLocationsMeeting QualitiesOrganizationsPeopleRecording ReportRecordingsReport TemplatesReportsResource Group MembershipsResource GroupsRolesSession TypesSpace ClassificationsTracking CodesWebex Calling Organization SettingsWebex Calling Person Settings
GETRead Person's Calling Behavior
PUTConfigure a person's Calling Behavior
GETRead Barge In Settings for a Person
PUTConfigure Barge In Settings for a Person
GETRead Forwarding Settings for a Person
PUTConfigure Call Forwarding Settings for a Person
GETRead Call Intercept Settings for a Person
PUTConfigure Call Intercept Settings for a Person
POSTConfigure Call Intercept Greeting for a Person
GETRead Call Recording Settings for a Person
PUTConfigure Call Recording Settings for a Person
GETRead Caller ID Settings for a Person
PUTConfigure Caller ID Settings for a Person
GETRead Do Not Disturb Settings for a Person
PUTConfigure Do Not Disturb Settings for a Person
GETRead Voicemail Settings for a Person
PUTConfigure Voicemail Settings for a Person
POSTConfigure Busy Voicemail Greeting for a Person
POSTConfigure No Answer Voicemail Greeting for a Person
GETList of Schedules for a Person
POSTCreate Schedule for a Person
GETGet a Schedule Details
PUTUpdate a Schedule
DELETEDelete a Schedule
GETFetch Event for a person's Schedule
POSTAdd a New Event for Person's Schedule
PUTUpdate an Event for a person's Schedule
DELETEDelete an Event for a person's Schedule
GETRead Call Waiting Settings for a Person
PUTConfigure Call Waiting Settings for a Person
GETRetrieve a person's Monitoring Settings
PUTModify a person's Monitoring Settings
GETGet a List of Phone Numbers for a Person
GETRetrieve a person's Application Services Settings
PUTModify a person's Application Services Settings
GETGet a person's Privacy Settings
PUTConfigure a person's Privacy Settings
GETRetrieve Executive Assistant Settings for a Person
PUTModify Executive Assistant Settings for a Person
GETRead Receptionist Client Settings for a Person
PUTConfigure Receptionist Client Settings for a Person
GETRead Push-to-Talk Settings for a Person
PUTConfigure Push-to-Talk Settings for a Person
GETRead Hoteling Settings for a Person
PUTConfigure Hoteling Settings for a Person
POSTReset Voicemail PIN
GETRead Incoming Permission Settings for a Person
PUTConfigure Incoming Permission Settings for a Person
GETRetrieve a person's Outgoing Calling Permissions Settings
PUTModify a person's Outgoing Calling Permissions Settings
PUTAssign or Unassign numbers to a person
GETRetrieve List of Call Queue Caller ID information
GETRetrieve a Call Queue Agent's Caller ID information
PUTModify a Call Queue Agent's Caller ID information
Webex Calling Workspace SettingsWholesale Billing ReportsWorkspace LocationsWorkspace MetricsWorkspaces
Calling
Overview
Guides
Integrations and AuthorizationWebex for BroadWorksWebex for WholesaleWholesale and Broadworks Common Guide
Reference
BroadWorks Billing ReportsBroadWorks Device ProvisioningBroadWorks EnterprisesBroadWorks SubscribersCall ControlsLocationsPeopleRecording ReportVideo MeshWebex Calling Detailed Call HistoryWebex Calling Organization SettingsWebex Calling Person Settings
GETRead Person's Calling Behavior
PUTConfigure a person's Calling Behavior
GETRead Barge In Settings for a Person
PUTConfigure Barge In Settings for a Person
GETRead Forwarding Settings for a Person
PUTConfigure Call Forwarding Settings for a Person
GETRead Call Intercept Settings for a Person
PUTConfigure Call Intercept Settings for a Person
POSTConfigure Call Intercept Greeting for a Person
GETRead Call Recording Settings for a Person
PUTConfigure Call Recording Settings for a Person
GETRead Caller ID Settings for a Person
PUTConfigure Caller ID Settings for a Person
GETRead Do Not Disturb Settings for a Person
PUTConfigure Do Not Disturb Settings for a Person
GETRead Voicemail Settings for a Person
PUTConfigure Voicemail Settings for a Person
POSTConfigure Busy Voicemail Greeting for a Person
POSTConfigure No Answer Voicemail Greeting for a Person
GETList of Schedules for a Person
POSTCreate Schedule for a Person
GETGet a Schedule Details
PUTUpdate a Schedule
DELETEDelete a Schedule
GETFetch Event for a person's Schedule
POSTAdd a New Event for Person's Schedule
PUTUpdate an Event for a person's Schedule
DELETEDelete an Event for a person's Schedule
GETRead Call Waiting Settings for a Person
PUTConfigure Call Waiting Settings for a Person
GETRetrieve a person's Monitoring Settings
PUTModify a person's Monitoring Settings
GETGet a List of Phone Numbers for a Person
GETRetrieve a person's Application Services Settings
PUTModify a person's Application Services Settings
GETGet a person's Privacy Settings
PUTConfigure a person's Privacy Settings
GETRetrieve Executive Assistant Settings for a Person
PUTModify Executive Assistant Settings for a Person
GETRead Receptionist Client Settings for a Person
PUTConfigure Receptionist Client Settings for a Person
GETRead Push-to-Talk Settings for a Person
PUTConfigure Push-to-Talk Settings for a Person
GETRead Hoteling Settings for a Person
PUTConfigure Hoteling Settings for a Person
POSTReset Voicemail PIN
GETRead Incoming Permission Settings for a Person
PUTConfigure Incoming Permission Settings for a Person
GETRetrieve a person's Outgoing Calling Permissions Settings
PUTModify a person's Outgoing Calling Permissions Settings
PUTAssign or Unassign numbers to a person
GETRetrieve List of Call Queue Caller ID information
GETRetrieve a Call Queue Agent's Caller ID information
PUTModify a Call Queue Agent's Caller ID information
Webex Calling Voice MessagingWebex Calling Workspace SettingsWholesale Billing ReportsWholesale CustomersWholesale Subscribers
Contact Center
Overview
Devices
Overview
Guides
DevicesWorkspace Integrations Guide
Reference
Device ConfigurationsDevicesWorkspace LocationsWorkspace MetricsWorkspace PersonalizationWorkspacesxAPI
Meetings
Overview
Guides
Integrations and AuthorizationWebhooksWebinar GuideMeeting Resource Guide
Reference
Meeting ChatsMeeting Closed CaptionsMeeting InviteesMeeting MessagesMeeting ParticipantsMeeting PollsMeeting PreferencesMeeting Q and AMeeting QualitiesMeeting TranscriptsMeetingsMeetings Summary ReportPeopleRecording ReportRecordingsSession TypesTracking CodesVideo MeshWebhooks
Messaging
Overview
Guides
BotsIntegrations and AuthorizationWebhooksButtons and Cards
Reference
Attachment ActionsEventsMembershipsMessagesPeopleRoom TabsRoomsTeam MembershipsTeamsTracking CodesWebhooks
Webex Assistant Skills
Guides
Skills SDK GuideSkills Developer PortalSkills Reference GuideSkills UX Guide
Overview
FedRAMP
Overview
Guides
Create a BotCreate an IntegrationNotes on API Support
Full API Reference
Admin Audit EventsAttachment ActionsAuthorizationsBroadWorks Billing ReportsBroadWorks Device ProvisioningBroadWorks EnterprisesBroadWorks SubscribersCall ControlsDevice ConfigurationsDevicesEventsGroupsHistorical AnalyticsHybrid ClustersHybrid ConnectorsLicensesLocationsMeeting ChatsMeeting Closed CaptionsMeeting InviteesMeeting MessagesMeeting ParticipantsMeeting PollsMeeting PreferencesMeeting Q and AMeeting QualitiesMeeting TranscriptsMeetingsMeetings Summary ReportMembershipsMessagesOrganizationsPeopleRecording ReportRecordingsReport TemplatesReportsResource Group MembershipsResource GroupsRolesRoom TabsRoomsSession TypesSiteSpace ClassificationsTeam MembershipsTeamsTracking CodesVideo MeshWebex Calling Detailed Call HistoryWebex Calling Organization SettingsWebex Calling Person Settings
GETRead Person's Calling Behavior
PUTConfigure a person's Calling Behavior
GETRead Barge In Settings for a Person
PUTConfigure Barge In Settings for a Person
GETRead Forwarding Settings for a Person
PUTConfigure Call Forwarding Settings for a Person
GETRead Call Intercept Settings for a Person
PUTConfigure Call Intercept Settings for a Person
POSTConfigure Call Intercept Greeting for a Person
GETRead Call Recording Settings for a Person
PUTConfigure Call Recording Settings for a Person
GETRead Caller ID Settings for a Person
PUTConfigure Caller ID Settings for a Person
GETRead Do Not Disturb Settings for a Person
PUTConfigure Do Not Disturb Settings for a Person
GETRead Voicemail Settings for a Person
PUTConfigure Voicemail Settings for a Person
POSTConfigure Busy Voicemail Greeting for a Person
POSTConfigure No Answer Voicemail Greeting for a Person
GETList of Schedules for a Person
POSTCreate Schedule for a Person
GETGet a Schedule Details
PUTUpdate a Schedule
DELETEDelete a Schedule
GETFetch Event for a person's Schedule
POSTAdd a New Event for Person's Schedule
PUTUpdate an Event for a person's Schedule
DELETEDelete an Event for a person's Schedule
GETRead Call Waiting Settings for a Person
PUTConfigure Call Waiting Settings for a Person
GETRetrieve a person's Monitoring Settings
PUTModify a person's Monitoring Settings
GETGet a List of Phone Numbers for a Person
GETRetrieve a person's Application Services Settings
PUTModify a person's Application Services Settings
GETGet a person's Privacy Settings
PUTConfigure a person's Privacy Settings
GETRetrieve Executive Assistant Settings for a Person
PUTModify Executive Assistant Settings for a Person
GETRead Receptionist Client Settings for a Person
PUTConfigure Receptionist Client Settings for a Person
GETRead Push-to-Talk Settings for a Person
PUTConfigure Push-to-Talk Settings for a Person
GETRead Hoteling Settings for a Person
PUTConfigure Hoteling Settings for a Person
POSTReset Voicemail PIN
GETRead Incoming Permission Settings for a Person
PUTConfigure Incoming Permission Settings for a Person
GETRetrieve a person's Outgoing Calling Permissions Settings
PUTModify a person's Outgoing Calling Permissions Settings
PUTAssign or Unassign numbers to a person
GETRetrieve List of Call Queue Caller ID information
GETRetrieve a Call Queue Agent's Caller ID information
PUTModify a Call Queue Agent's Caller ID information
Webex Calling Voice MessagingWebex Calling Workspace SettingsWebhooksWholesale Billing ReportsWholesale CustomersWholesale SubscribersWorkspace LocationsWorkspace MetricsWorkspace PersonalizationWorkspacesxAPI
API Changelog
SDKs
iOSAndroidBrowserNode.jsJava
Developer CommunityCertifications

Create Schedule for a Person

Create a new schedule for a person.

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.

POST/v1/people/{personId}/features/schedules
URI Parameters
personId
stringrequired

Unique identifier for the person.

Query Parameters
orgId
string

ID of the organization in which the person resides. 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
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 the 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 the 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 the 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 the 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. Not allowed with recurWeekly.

recurInterval
numberrequired

Recurring interval in days. 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. 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.
201CreatedThe request has succeeded and has led to the creation of a resource.
202AcceptedThe request has been accepted for processing.
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.
  • Try it
  • Example
POST
/v1/people//features/schedules{?orgId}
Log in to try the API.
Header
Query Parameters
  • ID of the organization in which the person resides. 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
  • Name for the schedule.
  • Indicates the schedule type whether `businessHours` or `holidays`.
  • Indicates a list of events.
  • Request
  • Response
https://webexapis.com/v1/people/Y2lzY29zcGFyazovL3VzL1BFT1BMRS8xMWEzZjk5MC1hNjg5LTQ3N2QtYmU2Yi03MTIwMDI1ZDhhYmI/features/schedules?orgId=Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE
{
  "name": "Dallas_Office_Hours",
  "type": "businessHours",
  "events": [
    {
      "name": "Day_Shift",
      "startDate": "2020-03-18",
      "endDate": "2020-03-18",
      "startTime": "08:00",
      "endTime": "17:00",
      "allDayEnabled": false,
      "recurrence": {
        "recurForEver": true,
        "recurEndDate": "2020-03-18",
        "recurEndOccurrence": 1,
        "recurDaily": {
          "recurInterval": 1
        },
        "recurWeekly": {
          "recurInterval": 1,
          "sunday": false,
          "monday": false,
          "tuesday": false,
          "wednesday": true,
          "thursday": false,
          "friday": false,
          "saturday": false
        }
      }
    }
  ]
}
201 / Created
{
  "id": "Y2lzY29zcGFyazovL3VzL1VTRVJfU0NIRURVTEUvUkdGc2JHRnpYMDltWm1salpWOUliM1Z5Y3c9PQ"
}

Connect

Support

Developer Events

Contact Sales

Handy Links

Webex Ambassadors

Webex App Hub

Resources

Open Source Bot Starter Kits

Download Webex

DevNet Learning Labs

Terms of Service

Privacy Policy

Cookie Policy

Trademarks

© 2023 Cisco and/or its affiliates. All rights reserved.