APIs
Getting StartedREST API BasicsComplianceWebhooksWebex APIs
Admin
Calling
Devices
imiconnect
Meetings
Messaging
Webex Assistant Skills
Full API Reference
API Changelog

Create Meeting Invitees

Invites people to attend a meeting in bulk.

Identify each invitee by the email address of each item in the items of the request body.

Each invitee should have a unique email.

This API limits the maximum size of items in the request body to 100.

POST/v1/meetingInvitees/bulkInsert
Body Parameters
meetingId
stringrequired

Unique identifier for the meeting to which the people are being invited. This attribute only applies to meeting series and scheduled meeting. 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.

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 in a site they manage to be the meeting host.

items
array[CreateInviteesItemObject]

Meeting invitees to be inserted

email
stringrequired

Email address for meeting invitee.

displayName
string

Display name for meeting invitee. The maximum length of displayName is 384 bytes. 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. If displayName is not specified and the email has not been associated with an existing Webex account, the email will be used instead.

coHost
boolean

Whether or not invitee is a designated alternate host for the meeting. See Add Alternate Hosts for Cisco Webex Meetings for more details.

sendEmail
boolean

Whether or not send email to invitee.

Response Properties
items
array[CreateInviteesItemResponseObject]

Meeting invitees inserted

id
string

Unique identifier for meeting invitee.

meetingId
string

Unique identifier for the meeting to which a person is being invited. This attribute only applies to meeting series and scheduled meeting. If it's a meeting series, the meeting invitee is invited to the entire meeting series; if it's a scheduled meeting, the meeting invitee is invited to this individual scheduled meeting. It doesn't apply to an ended or ongoing meeting instance.

email
string

Email address for meeting invitee.

displayName
string

Display name for meeting invitee. The maximum length of displayName is 384 bytes. 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. If displayName is not specified and the email has not been associated with an existing Webex account, the email will be used instead.

coHost
boolean

Whether or not invitee is a designated alternate host for the meeting. See Add Alternate Hosts for Cisco Webex Meetings for more details.

Response Codes

The list below describes the common success and error responses you should expect from the API.

CodeStatusDescription
200OKSuccessful request with body content.
204No ContentSuccessful request without body content.
400Bad RequestThe request was invalid or cannot be otherwise served. An accompanying error message will explain further.
401UnauthorizedAuthentication credentials were missing or incorrect.
403ForbiddenThe request is understood, but it has been refused or access is not allowed.
404Not FoundThe URI requested is invalid or the resource requested, such as a user, does not exist. Also returned when the requested format is not supported by the requested method.
405Method Not AllowedThe request was made to a resource using an HTTP request method that is not supported.
409ConflictThe request could not be processed because it conflicts with some established rule of the system. For example, a person may not be added to a room more than once.
410GoneThe requested resource is no longer available.
415Unsupported Media TypeThe request was made to a resource without specifying a media type or used a media type that is not supported.
423LockedThe requested resource is temporarily unavailable. A Retry-After header may be present that specifies how many seconds you need to wait before attempting the request again.
428Precondition RequiredFile(s) cannot be scanned for malware and need to be force downloaded.
429Too Many RequestsToo many requests have been sent in a given amount of time and the request has been rate limited. A Retry-After header should be present that specifies how many seconds you need to wait before a successful request can be made.
500Internal Server ErrorSomething went wrong on the server. If the issue persists, feel free to contact the Webex Developer Support team.
502Bad GatewayThe server received an invalid response from an upstream server while processing the request. Try again later.
503Service UnavailableServer is overloaded with requests. Try again later.
504Gateway TimeoutAn upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.
POST
/v1/meetingInvitees/bulkInsert
Log in to try the API.
Header
Body
  • Unique identifier for the meeting to which the people are being invited. This attribute only applies to meeting series and scheduled meeting. 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.
  • 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.
  • Meeting invitees to be inserted
{
    "meetingId": "870f51ff287b41be84648412901e0402",
    "hostEmail": "brenda.song@example.com",
    "items": [
        {
            "email": "john.andersen@example.com",
            "displayName": "John Andersen",
            "coHost": false,
            "sendEmail": true
        },
        {
            "email": "jack.andersen@example.com",
            "displayName": "Jack Andersen",
            "coHost": false,
            "sendEmail": true
        }
    ]
}
200 / OK
{
    "items": [
        {
            "id": "870f51ff287b41be84648412901e0402_2628962",
            "meetingId": "870f51ff287b41be84648412901e0402",
            "email": "john.andersen@example.com",
            "displayName": "John Andersen",
            "coHost": false
        },
        {
            "id": "870f51ff287b41be84648412901e0402_2628963",
            "meetingId": "870f51ff287b41be84648412901e0402",
            "email": "jack.andersen@example.com",
            "displayName": "Jack Andersen",
            "coHost": false
        }
    ]
}