{ "opencollection": "1.0.0", "info": { "name": "Webex Admin Address Book Invitees API", "version": "1.0.0" }, "items": [ { "info": { "name": "Invitees", "type": "folder" }, "items": [ { "info": { "name": "List Meeting Invitees", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/meetingInvitees", "params": [ { "name": "meetingId", "value": "870f51ff287b41be84648412901e0402", "type": "query", "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. 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." }, { "name": "max", "value": "100", "type": "query", "description": "Limit the maximum number of meeting invitees in the response, up to 100." }, { "name": "hostEmail", "value": "brenda.song@example.com", "type": "query", "description": "Email address for the meeting host. This parameter is only used if the user or application calling the API has the admin on-behalf-of scopes. If set, the admin may specify the email of a user in a site they manage and the API will return meeting invitees that are hosted by that user." }, { "name": "panelist", "value": "true", "type": "query", "description": "Filter invitees or attendees for webinars only. If `true`, returns invitees. If `false`, returns attendees. If `null`, returns both invitees and attendees." } ] }, "docs": "Lists meeting invitees for a meeting with a specified `meetingId`. You can set a maximum number of invitees to return.\n\nThis operation can be used for meeting series, scheduled meetings, and ended or ongoing meeting instance objects. If the specified `meetingId` is for a meeting series, the invitees for the series will be listed; if the `meetingId` is for a scheduled meeting, the invitees for the particular scheduled meeting will be listed; if the `meetingId` is for an ended or ongoing meeting i" }, { "info": { "name": "Create a Meeting Invitee", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/meetingInvitees", "body": { "type": "json", "data": "{}" } }, "docs": "* Invite a person to attend a meeting.\n\n* Identify the invitee in the request body, by email address.\n\n* The `sendEmail` parameter is `true` by default and the meeting emails will be sent to the invitee's `email`. Please set `sendEmail` to `false` to prevent the invitee from receiving emails." }, { "info": { "name": "Create Meeting Invitees", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/meetingInvitees/bulkInsert", "body": { "type": "json", "data": "{}" } }, "docs": "* Invite people to attend a meeting in bulk.\n\n* Identify each invitee by the email address of each item in the `items` of the request body.\n\n* Each invitee should have a unique `email`.\n\n* This API limits the maximum size of `items` in the request body to 100.\n\n* The `sendEmail` parameter for each invitee is `true` by default and the meeting emails will be sent to the invitee's `email`. Please set `sendEmail` to `false` to prevent an invitee from receiving emails." }, { "info": { "name": "Get a Meeting Invitee", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/meetingInvitees/:meetingInviteeId", "params": [ { "name": "meetingInviteeId", "value": "870f51ff287b41be84648412901e0402_2628962", "type": "path", "description": "Unique identifier for the invitee whose details are being requested." }, { "name": "hostEmail", "value": "brenda.song@example.com", "type": "query", "description": "Email address for the meeting host. This parameter is only used if the user or application calling the API has the admin on-behalf-of scopes. If set, the admin may specify the email of a user in a site they manage and the API will return details for a meeting invitee that is hosted by that user." } ] }, "docs": "Retrieve details for a meeting invitee identified by a `meetingInviteeId` in the URI." }, { "info": { "name": "Update a Meeting Invitee", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/meetingInvitees/:meetingInviteeId", "params": [ { "name": "meetingInviteeId", "value": "870f51ff287b41be84648412901e0402_2628962", "type": "path", "description": "Unique identifier for the invitee to be updated. This parameter only applies to an invitee to a meeting series or a scheduled meeting. It doesn't apply to an invitee to an ended or ongoing meeting instance." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update details for a meeting invitee identified by a `meetingInviteeId` in the URI." }, { "info": { "name": "Delete a Meeting Invitee", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/meetingInvitees/:meetingInviteeId", "params": [ { "name": "meetingInviteeId", "value": "870f51ff287b41be84648412901e0402_2628962", "type": "path", "description": "Unique identifier for the invitee to be removed. This parameter only applies to an invitee to a meeting series or a scheduled meeting. It doesn't apply to an invitee to an ended or ongoing meeting instance." }, { "name": "hostEmail", "value": "brenda.song@example.com", "type": "query", "description": "Email address for the meeting host. This parameter is only used if the user or application calling the API has the admin on-behalf-of scopes. If set, the admin may specify the email of a user in a site they manage and the API will delete a meeting invitee that is hosted by that user." }, { "name": "sendEmail", "value": "true", "type": "query", "description": "If `true`, send an email to the invitee." } ] }, "docs": "Removes a meeting invitee identified by a `meetingInviteeId` specified in the URI. The deleted meeting invitee cannot be recovered.\n\nIf the meeting invitee is associated with a meeting series, the invitee will be removed from the entire meeting series. If the invitee is associated with a scheduled meeting, the invitee will be removed from only that scheduled meeting." } ] } ], "bundled": true }