Register a plugin for an account

POST /plugin/register

Installs a plugin for a RingCentral account. The route validates administrator access and account identity, resolves the selected platform entry from the Developer Console plugin manifest, calls its registration URL with the short-lived RingCentral administrator token, and stores the returned opaque plugin credential and manifest metadata.

Operation ID: postPluginRegister
Authorization: API key or API key

Request body

Plugin and RingCentral account identifiers to register.

Required: Yes

Content type: application/json

Schema: PluginRegisterRequest

{
  "pluginId": "plugin.example",
  "rcAccountId": "123456789",
  "pluginAccess": "shared",
  "pluginName": "examplePlugin"
}

Responses

Status	Description	Body
200	The plugin was registered for the account.	PluginMutationResponse
400	Bad request, missing authentication, or connector error.	ErrorResponse, string
403	The caller is authenticated but is not permitted to perform the operation.	ErrorResponse, string