SMsmokeball
Plugins

Update existing plugin

Updates a plugin with the specified plugin details.

put/plugins/{pluginId}

Request

  • Base URL
    https://api.smokeball.com
  • URL
    https://api.smokeball.com/plugins/{pluginId}
  • Auth
    API key in header x-api-key and API key in header Authorization

Path parameters

pluginIdstring uuid required

Request body

externalIdstring nullable

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

application'Native' | 'Web' | 'Archie'

The application that the plugin should be rendered in.

type'Button' | 'Tab'

The type of component the plugin should represent.

keystring nullable

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

additionalDataobject nullable

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

Response

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

idstring nullable
hrefstring nullable
relationstring nullable
methodstring nullable

Changes

No recorded changes to this operation across all 15 revisions of this API.