Update a Plugin

Update the fields of a Plugin object

Parameter

Accessible via URL https://api.channel.io/open/v3/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/v3/plugins/1234

Your PATCH body should look like

{
  "name" : "changed"
}

Response

Returns the changed Plugin object.

{
  "plugin": {
    "id": "String",
    "key": "String",
    "channelId": "String",
    "state": "active",
    "name": "String",
    "createdAt": 1490355528218,
    "color": "String",
    "botName": "String",
    "deskMarginX": 60,
    "deskMarginY": 24,
    "deskPosition": "String",
    "mobileMarginX": 14,
    "mobileMarginY": 18,
    "mobilePosition": "String",
    "mobileHideButton": Boolean,
    "accessSecret": "String",
    "welcomeI18n": {
      "text": "String",
      "en": "String",
      "ja": "String",
      "ko": "String"
    },
    "profileBot": Boolean,
    "profileBotMessageI18n": {
      "text": "String",
      "en": "String",
      "ja": "String"
    },
    "profileBotSchemaIds": [
      "String",
      "String"
    ],
    "showPoweredBy": Boolean,
    "textColor": "String",
    "borderColor": "String",
    "gradientColor": "String"
  }
}