Update Channel

Overview

Use this API to update an existing channel in the Conversation Manager with your specific custom requirements.

Scope

Client application must have 'app.conversation.conversationmgr.manage' scope assigned.

SecurityoAuthClient
Request
path Parameters
id
required
string = 36 characters

id of object

Example: 7b6c5fff-036e-4a40-b68a-a67c592fc079
Request Body schema: application/json

Update channel

type
required
string [ 1 .. 255 ] characters

Unique channel type. Do not prefix with 'custom.' for channels supported by eGain.

displayName
required
string [ 1 .. 255 ] characters
icon
required
string [ 1 .. 512000 ] characters

base64 encoded image. This icon is used in eGain Chat Advisor desktop for activities of this channel. If eGain Chat is used for live agents then use icon file in ‘png’ format with pixel dimensions 32 X 32.

description
string [ 1 .. 1023 ] characters
active
boolean
Default: true
object (Restrictions)

Channel restriction on inbound(from customer) and outbound( to customer) messages.

Array of objects (L10nProperties) [ 1 .. 25 ] items
modified
string <date-time>

Last modified time in GMT

Responses
204

No Content

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal server error

put/channels/{id}
Request samples
application/json
{
  • "type": "custom_channel",
  • "icon": "<base64>",
  • "displayName": "Custom Channel",
  • "description": "Custom Channel",
  • "active": true,
  • "modified": "2021-06-11T23:14:41.836Z",
  • "restrictions": {
    },
  • "l10nProperties": [
    ]
}
Response samples
application/json

Required attribute is missing in payload

{
  • "code": "400-143",
  • "developerMessage": "Required attribute is missing in the request body: <attribute>"
}