TRMNL Octri Demo
PATCH/api/my_plugins/{id}

Change a third-party plugin

Updates the metadata and integration settings for a third-party plugin. Supply only the fields you want to change; omitted fields keep their existing values, and the plugin's status cannot be changed here.

  • IdempotentThe SDK sends Idempotency-Key, so a retried request is only applied once.

1 parameter · 11 body fields
idintegerrequired
The integer identifier of the plugin to update.

Plugin metadata and integration settings to change. Fields omitted from the request keep their existing values.

categoryarray<string>optional
One or more of the categories listCategories answers
descriptionstringoptional
A description of the plugin. Maximum 35 characters.
installation_success_webhook_urlstringoptional
The URL to call after a plugin installation succeeds.
installation_urlstringoptional
Where an installer is sent to connect; your OAuth authorize page
knowledge_base_urlstringoptional
The URL of the plugin's knowledge base.
namestringoptional
The plugin's name.
no_screen_paddingbooleanoptional
Whether the plugin's content is displayed without screen padding.
plugin_management_urlstringoptional
Where an installer manages the connection on your site
plugin_markup_urlstringoptional
Your endpoint that answers the markup for a render
refresh_everyintegeroptional
Minutes between renders
Allowed:1440720480360240120603015
uninstallation_webhook_urlstringoptional
The URL to call when the plugin is uninstalled.

4 status codes
200Returns the updated plugin data, including its identifier, name, categories, integration URLs, and refresh interval.
dataobjectoptional
401Returned when the request is not authenticated.
errorstringoptional
404Returned when the plugin belongs to another user.
422Returned when a required field is blanked.

Error handling

A 401 is returned when the request is not authenticated. A 404 is returned when the plugin belongs to another user. A 422 is returned when a required field is blanked; refresh_every, if supplied, must be one of 1440, 720, 480, 360, 240, 120, 60, 30, or 15 minutes, and description must not exceed 35 characters.