Webex · Schema

GetInviteeObject

CallingCollaborationCommunicationEnterpriseMessagingVideo Conferencing

Properties

Name Type Description
id string Unique identifier for meeting invitee.
email string Email address for meeting invitee. This attribute can be modified by `Update a Meeting Invitee` API.
displayName string Display name for meeting invitee. This attribute can be modified by `Update a Meeting Invitee` API.
coHost boolean Whether or not 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.
meetingId string Unique identifier for the meeting for which invitees are being requested. The meeting can be a meeting series, a scheduled meeting, or a meeting instance which has ended or is ongoing.
panelist boolean If `true`, the invitee is a designated panelist for the event meeting.
View JSON Schema on GitHub

JSON Schema

webex-getinviteeobject-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/GetInviteeObject",
  "title": "GetInviteeObject",
  "type": "object",
  "required": [
    "id",
    "email",
    "displayName",
    "meetingId"
  ],
  "properties": {
    "id": {
      "type": "string",
      "example": "870f51ff287b41be84648412901e0402_2628962",
      "description": "Unique identifier for meeting invitee."
    },
    "email": {
      "type": "string",
      "example": "[email protected]",
      "description": "Email address for meeting invitee. This attribute can be modified by `Update a Meeting Invitee` API."
    },
    "displayName": {
      "type": "string",
      "example": "John Andersen",
      "description": "Display name for meeting invitee. This attribute can be modified by `Update a Meeting Invitee` API."
    },
    "coHost": {
      "type": "boolean",
      "description": "Whether or not 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."
    },
    "meetingId": {
      "type": "string",
      "example": "870f51ff287b41be84648412901e0402",
      "description": "Unique identifier for the meeting for which invitees are being requested. The meeting can be a meeting series, a scheduled meeting, or a meeting instance which has ended or is ongoing."
    },
    "panelist": {
      "type": "boolean",
      "description": "If `true`, the invitee is a designated panelist for the event meeting."
    }
  }
}