Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

RingCentral Invitees API

External APIs to manage webinar invitees and invitations

RingCentral Invitees API is one of 88 APIs that RingCentral publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Invitees. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

This API exposes 5 operations across 2 paths, and defines 27 schemas. It is described by OpenAPI 3.0.3, at version 1.0.58-20240529-47eda8bd.

Requests are made against 4 base URLs: https://platform.ringcentral.com, https://media.ringcentral.com, https://platform.devtest.ringcentral.com, https://platform.devtest.ringcentral.com.

5 operations 2 paths 27 schemas 1 DELETE2 GET1 PATCH1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
1.0.58-20240529-47eda8bd
Servers
https://platform.ringcentral.com
https://media.ringcentral.com
https://platform.devtest.ringcentral.com
https://platform.devtest.ringcentral.com
Authentication
OAuth 2.0
Terms of Service
Resource Areas
1

Authentication & Security 1

RingCentral Invitees API declares 1 security scheme for authenticating requests. It supports OAuth 2.0 (OAuth2) using the authorizationCode flow. By default, every request must be authenticated.

Paths & Operations 5

Across 2 paths, the API surfaces 5 operations — 1 DELETE, 2 GET, 1 PATCH, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Invitees 5

External APIs to manage webinar invitees and invitations

PATCH
/webinar/configuration/v1/webinars/{webinarId}/sessions/{sessionId}/invitees
Bulk Add/Delete Session Invitees
rcwConfigUpdateInvitees 2 params body → 200400403404409500
GET
/webinar/configuration/v1/webinars/{webinarId}/sessions/{sessionId}/invitees
List Session Invitees
rcwConfigListInvitees 4 params → 200400403404500
GET
/webinar/configuration/v1/webinars/{webinarId}/sessions/{sessionId}/invitees/{inviteeId}
Get Session Invitee
rcwConfigGetInvitee 3 params → 200400403404500
PUT
/webinar/configuration/v1/webinars/{webinarId}/sessions/{sessionId}/invitees/{inviteeId}
Update Session Invitee
rcwConfigUpdateInvitee 3 params body → 200400403404500
DELETE
/webinar/configuration/v1/webinars/{webinarId}/sessions/{sessionId}/invitees/{inviteeId}
Delete Session Invitee
rcwConfigDeleteInvitee 3 params → 204403404500

Schemas 27

The contract defines 27 schemas that model the data the API accepts and returns. The most detailed are RcwPagingForwardModel (4 properties), BulkUpdateInviteesRequest (3 properties), BulkUpdateInviteesResponse (3 properties), InviteeGeneratedModel (2 properties). Each schema is shown below with its type and property counts.

BulkUpdateInviteesRequest
object
3 properties
ApiErrorWithParameter
The error model with additional attributes which can be used for HTTP 400/409 This is a deprecated model: "ApiError" model can be used instead with arbitrary a…
ApiError
object
Generalized API error structure suitable for any error type
2 properties 2 required
RcwEmailModel
string
User's contact email
ApiErrorResponseModel
object
Standard error response model which is returned in case of any unsuccessful operation
1 property 1 required
InviteeContactModel
RcwDomainUserModel
BulkUpdateInviteesResponse
object
3 properties
RcwResourceBaseModel
RcwUserModel
object
2 properties 2 required
RcwPagingForwardModel
object
4 properties 2 required
AddInviteeRequest
InviteeResource
RcwRoleEnum
string
The role of the webinar session participant/invitee. See also: [Understanding Webinar Roles](https://support.ringcentral.com/webinar/getting-started/understand…
UpdateInviteeRequest
RcwImmutableResourceIdModel
object
1 property
RcwRoleAttributeModel
object
The attribute declaration to indicate webinar session participant/invitee role
1 property 1 required
RcwResourceIdModel
object
1 property
ParameterizedErrorResponseModel
object
Standard error response which may include parameterized errors
1 property 1 required
WcsInviteeListResource
object
2 properties 2 required
RcwBaseContactModel
object
2 properties
RcwLinkedUserModel
object
The internal IDs of RC-authenticated users.
1 property
InviteeGeneratedModel
object
2 properties
InviteeBaseModel
RcwPagingModel
RcwInviteeTypeEnum
string
The type of the webinar invitee
InviteeSettingsModel
object
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

ringcentral-invitees-api-openapi.yml Raw ↑

Other APIs RingCentral publishes across the network.

RingCentral SMS API
RingCentral Team Messaging API
RingCentral Video API
RingCentral Fax API
RingCentral Data API
RingCentral Audio and Video AI API
RingCentral Call Log API
RingCentral Call Analytics API
RingCentral Presence API
RingCentral Voicemail API
RingCentral Provisioning API
RingCentral Webhooks and Subscriptions API