Webex · Schema

UserScheduleEventPatch

Modify the Schedule Event configuration.

CallingCollaborationCommunicationEnterpriseMessagingVideo Conferencing

Properties

Name Type Description
name string Name for the event.
newName string New Name for the event.
startDate string Start Date of Event.
endDate string End Date of Event.
startTime string Start time of event.
endTime string End time of event.
allDayEnabled boolean An indication of whether given event is an all-day event or not.
recurrence object
View JSON Schema on GitHub

JSON Schema

webex-userscheduleeventpatch-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/UserScheduleEventPatch",
  "title": "UserScheduleEventPatch",
  "type": "object",
  "description": "Modify the Schedule Event configuration.",
  "required": [
    "name",
    "startDate",
    "endDate",
    "allDayEnabled"
  ],
  "example": {
    "name": "EVENT",
    "newName": "Event Name",
    "startDate": "2023-02-06",
    "endDate": "2023-02-06",
    "allDayEnabled": true,
    "recurrence": {
      "recurForEver": true,
      "recurYearlyByDay": {
        "day": "MONDAY",
        "week": "FIRST",
        "month": "FEBRUARY"
      }
    }
  },
  "properties": {
    "name": {
      "type": "string",
      "example": "EVENT",
      "description": "Name for the event."
    },
    "newName": {
      "type": "string",
      "example": "Event Name",
      "description": "New Name for the event."
    },
    "startDate": {
      "type": "string",
      "example": "2021-11-01",
      "description": "Start Date of Event."
    },
    "endDate": {
      "type": "string",
      "example": "2021-11-30",
      "description": "End Date of Event."
    },
    "startTime": {
      "type": "string",
      "example": "12:20",
      "description": "Start time of event."
    },
    "endTime": {
      "type": "string",
      "example": "14:20",
      "description": "End time of event."
    },
    "allDayEnabled": {
      "type": "boolean",
      "description": "An indication of whether given event is an all-day event or not."
    },
    "recurrence": {
      "$ref": "#/components/schemas/UserScheduleRecurrenceObject"
    }
  }
}