Webex · Schema

UpdateInviteeObject

CallingCollaborationCommunicationEnterpriseMessagingVideo Conferencing

Properties

Name Type Description
email string Email address for meeting invitee.
displayName string Display name for meeting invitee. The maximum length of `displayName` is 128 characters. In the Webex app, if the email has been associated with an existing Webex account, the display name associated
coHost boolean Whether or not the invitee is a designated alternate host for the meeting. See [Add Alternate Hosts for Cisco Webex Meetings](https://help.webex.com/b5z6he/) for more details.
hostEmail string Email address for the meeting host. This attribute should only be set if the user or application calling the API has the admin on-behalf-of scopes. When used, the admin may specify the email of a user
sendEmail boolean If `true`, send an email to the invitee.
panelist boolean If `true`, the invitee is a designated panelist for the event meeting.
View JSON Schema on GitHub

JSON Schema

webex-updateinviteeobject-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/UpdateInviteeObject",
  "title": "UpdateInviteeObject",
  "type": "object",
  "required": [
    "email"
  ],
  "properties": {
    "email": {
      "type": "string",
      "example": "[email protected]",
      "description": "Email address for meeting invitee."
    },
    "displayName": {
      "type": "string",
      "example": "John Andersen",
      "description": "Display name for meeting invitee. The maximum length of `displayName` is 128 characters. In the Webex app, if the email has been associated with an existing Webex account, the display name associated with the Webex account will be used; otherwise, the `email` will be used as `displayName`. In a Webex site, if `displayName` is specified, it will show `displayName`. If `displayName` is not specified, and the `email` has been associated with an existing Webex account, the display name associated with the Webex account will be used; otherwise, the `email` will be used as `displayName`.\n\nIf the invitee has an existing Webex account, the `displayName` shown in the meeting will be the `displayName` associated with the Webex account; otherwise, `displayName` shown in the meeting will be the `displayName` which is specified by the invitee who does not have a Webex account."
    },
    "coHost": {
      "type": "boolean",
      "description": "Whether or not the invitee is a designated alternate host for the meeting. See [Add Alternate Hosts for Cisco Webex Meetings](https://help.webex.com/b5z6he/) for more details."
    },
    "hostEmail": {
      "type": "string",
      "example": "[email protected]",
      "description": "Email address for the meeting host. This attribute should only be set if the user or application calling the API has the admin on-behalf-of scopes. When used, the admin may specify the email of a user in a site they manage to be the meeting host."
    },
    "sendEmail": {
      "type": "boolean",
      "example": true,
      "description": "If `true`, send an email to the invitee."
    },
    "panelist": {
      "type": "boolean",
      "description": "If `true`, the invitee is a designated panelist for the event meeting."
    }
  }
}