Webex · Schema

CreateInviteesObject

CallingCollaborationCommunicationEnterpriseMessagingVideo Conferencing

Properties

Name Type Description
meetingId string Unique identifier for the meeting to which the people are being invited. This attribute only applies to meeting series and scheduled meetings. If it's a meeting series, the meeting invitees are invite
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
items array Meeting invitees to be inserted.
View JSON Schema on GitHub

JSON Schema

webex-createinviteesobject-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/CreateInviteesObject",
  "title": "CreateInviteesObject",
  "type": "object",
  "required": [
    "meetingId"
  ],
  "properties": {
    "meetingId": {
      "type": "string",
      "example": "870f51ff287b41be84648412901e0402",
      "description": "Unique identifier for the meeting to which the people are being invited. This attribute only applies to meeting series and scheduled meetings. If it's a meeting series, the meeting invitees are invited to the entire meeting series; if it's a scheduled meeting, the meeting invitees are invited to this individual scheduled meeting. It doesn't apply to an ended or ongoing meeting instance. The meeting ID of a scheduled [personal room](https://help.webex.com/en-us/article/nul0wut/Webex-Personal-Rooms-in-Webex-Meetings) meeting is not supported for this API."
    },
    "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."
    },
    "items": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/CreateInviteesItemObject"
      },
      "description": "Meeting invitees to be inserted."
    }
  }
}