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":{
      "additionalProp1":"string",
      "additionalProp2":"string",
      "additionalProp3":"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,
   "mobileBubblePosition":"top",
   "urlWhitelist":[
      "string"
   ],
   "runRate":0,
   "deskImageUrl":"string",
   "mobileImageUrl":"string",
   "validLabelButtonText":true,
   "validLabelButtonTextI18nMap":true
}

Response

Returns the changed Plugin object.

{
  "plugin": {
    "id": "string",
    "key": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "channelId": "string",
    "state": "waiting",
    "name": "string",
    "createdAt": 1656032150208,
    "labelButton": true,
    "labelButtonText": "string",
    "labelButtonTextI18nMap": {
      "additionalProp1": "string",
      "additionalProp2": "string",
      "additionalProp3": "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,
    "mobileBubblePosition": "top",
    "accessSecret": "string",
    "urlWhitelist": [
      "string"
    ],
    "runRate": 0,
    "facebookPixelId": "string",
    "deskImageUrl": "string",
    "mobileImageUrl": "string",
    "validLabelButtonText": true,
    "validLabelButtonTextI18nMap": true
  }
}