Webex · Schema

ExecutiveAssistantSettingsPut

Request Payload to update settings for an executive assistant.

CallingCollaborationCommunicationEnterpriseMessagingVideo Conferencing

Properties

Name Type Description
forwardFilteredCallsEnabled boolean If `true`, filtered calls to assistant are forwarded to the `forwardToPhoneNumber`.
forwardToPhoneNumber string Phone number to forward the filtered calls to. Mandatory if `forwardFilteredCallsEnabled` is set to true.
executives array List of executives.
View JSON Schema on GitHub

JSON Schema

webex-executiveassistantsettingsput-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/ExecutiveAssistantSettingsPut",
  "title": "ExecutiveAssistantSettingsPut",
  "type": "object",
  "description": "Request Payload to update settings for an executive assistant.",
  "example": {
    "forwardFilteredCallsEnabled": true,
    "forwardToPhoneNumber": "+19075552860",
    "executives": [
      {
        "personId": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS8zZWQzNDg0MS0yZTkwLTQ4OGEtYmVmZi1iNTk0OTA1ODFkNWM",
        "optInEnabled": true
      }
    ]
  },
  "properties": {
    "forwardFilteredCallsEnabled": {
      "type": "boolean",
      "example": true,
      "description": "If `true`, filtered calls to assistant are forwarded to the `forwardToPhoneNumber`."
    },
    "forwardToPhoneNumber": {
      "type": "string",
      "example": "+19075552860",
      "description": "Phone number to forward the filtered calls to. Mandatory if `forwardFilteredCallsEnabled` is set to true."
    },
    "executives": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/ExecutivePut"
      },
      "description": "List of executives."
    }
  }
}