Update Participant

Overview

Use this API to update an existing participant.

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 participant

name
required
string [ 1 .. 255 ] characters

Unique name for participant

type
required
string

Type of participant. eGain Bot participants are created automatically when bot is created in eGain VA application.

Enum: "custom_bot" "egain_bot"
description
string [ 1 .. 1023 ] characters
active
boolean
Default: true
required
object
object (Intents)

Intents supported by bot.

Array of objects (Attribute) [ 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/participants/{id}
Request samples
application/json
{
  • "name": "custom_bot_participant",
  • "type": "custom_bot",
  • "active": true,
  • "application": {
    },
  • "modified": "2021-03-06T21:16:36.838Z"
}
Response samples
application/json

Required attribute is missing in payload

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