Skip to main content
PUT
Update existing plugin

Authorizations

x-api-key
string
header
required
Authorization
string
header
required

Path Parameters

pluginId
string<uuid>
required

Body

externalId
string | null

Optional id provided by the external system that owns this plugin.

application
enum<string>

The application that the plugin should be rendered in.

Available options:
Native,
Web,
Archie
type
enum<string>

The type of component the plugin should represent.

Available options:
Button,
Tab
version
object | null

Current version of the plugin.

key
string | null

Signing key of the plugin to verify integrity of requesting secure URLs. Only available to set on Plugin creation.

additionalData
object | null

Collection of KeyValuePair(string, object) to update Plugin meta data.

Response

When request is accepted. Returns a 'Link' object.

id
string | null
href
string | null
relation
string | null
method
string | null
default:GET