Update a Plugin
Update the fields of a Plugin
object
Parameter
Accessible via URL https://api.channel.io/open/v4/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/v4/plugins/1234
Your PATCH body should look like
{
"name":"string",
"color":"string",
"textI18n":{
"text":"string",
"en":"string",
"ja":"string",
"ko":"string"
},
"botName":"string",
"deskImage":{
"bucket":"string",
"key":"string",
"width":0,
"height":0
},
"deskMarginX":0,
"deskMarginY":0,
"deskPosition":"left",
"mobileImage":{
"bucket":"string",
"key":"string",
"width":0,
"height":0
},
"mobileMarginX":0,
"mobileMarginY":0,
"mobilePosition":"left",
"mobileHideButton":true,
"welcomeI18n":{
"text":"string",
"en":"string",
"ja":"string",
"ko":"string"
},
"profileBot":true,
"profileBotMessageI18n":{
"text":"string",
"en":"string",
"ja":"string",
"ko":"string"
},
"profileBotSchemaIds":[
"string"
],
"urlWhitelist":[
"string"
],
"runRate":0,
"textColor":"string",
"deskImageUrl":"string",
"mobileImageUrl":"string",
"borderColor":"string",
"gradientColor":"string"
}
Response
Returns the changed Plugin
object.
{
"plugin": {
"id": "string",
"key": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"channelId": "string",
"state": "waiting",
"name": "string",
"createdAt": 1624422363157,
"color": "string",
"textI18n": {
"text": "string",
"en": "string",
"ja": "string",
"ko": "string"
},
"botName": "string",
"deskImage": {
"bucket": "string",
"key": "string",
"width": 0,
"height": 0
},
"deskMarginX": 0,
"deskMarginY": 0,
"deskPosition": "left",
"mobileImage": {
"bucket": "string",
"key": "string",
"width": 0,
"height": 0
},
"mobileMarginX": 0,
"mobileMarginY": 0,
"mobilePosition": "left",
"mobileHideButton": true,
"accessSecret": "string",
"welcomeI18n": {
"text": "string",
"en": "string",
"ja": "string",
"ko": "string"
},
"profileBot": true,
"profileBotMessageI18n": {
"text": "string",
"en": "string",
"ja": "string",
"ko": "string"
},
"profileBotSchemaIds": [
"string"
],
"urlWhitelist": [
"string"
],
"runRate": 0,
"facebookPixelId": "string",
"textColor": "string",
"deskImageUrl": "string",
"mobileImageUrl": "string",
"borderColor": "string",
"gradientColor": "string"
}
}
Updated 12 months ago