Create a Plugin

❗️

This documentation is deprecated

This API is deprecated since November 27th, 2020.
Support of this APIs will end in November 26th, 2021.

Create a Plugin

Parameter

Accessible via URL https://api.channel.io/open/v3/plugins and HTTP POST

📘

This method accepts application/json

Parameter

Example

Required

Description

Parameter type

name

channelPlugin

Required

Name of the Plugin object

Body

Example

POST https://api.channel.io/open/v3/plugins

The POST request body should look like

{
  "name" : "channelPlugin"
}

Response

Returns a newly created 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"
  }
}