Category
Plugin
Plugin
Get a single Plugin
Retrieve a single Plugin object. Parameter Accessible via URL https://api.channel.io/open/v5/plugins/{pluginId} and HTTP GET This method accepts application/json Parameter Example Required Description Parameter type pluginId 1004 Required ID of a Plugin Path Example GET https://api.channel.io/open/v5/plugins/1234 Response Returns a Plugin object { "plugin": { "id": "string", "key": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "channelId": "string", "state": "waiting", "name": "string", "createdAt": 1
List of Plugins
Retrieve a list of Plugin objects. Parameter Accessible via URL https://api.channel.io/open/v5/plugins and HTTP GET This method accepts application/json Parameter Example Required Description Parameter type since 1624422349278 Optional Unix timestamp value of the first plugin to be retrieved in ascending order Query limit 25 Optional Restrict the maximum number of plugins to be retrieved - min : 1 - max : 500 - default : 25 Query Example GET https://api.channel.io/open/v5/plugins?limit=25 Respon
Update a Plugin
Update the fields of a Plugin object. Parameter Accessible via URL https://api.channel.io/open/v5/plugin and HTTP PATCH This method accepts application/json Parameter Example Required Description Parameter type pluginId 12345 Required ID of Plugin object Path (property) (name) Optional Property of Plugin Body Example PATCH https://api.channel.io/open/v5/plugins/1234 Your PATCH body should look like { "name":"string", "labelButton":true, "labelButtonText":"string", "labelButtonTextI18nMap":{ "add