Skip to content

Update Participant

Request

Overview

Use this API to update an existing participant.

Scope

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

Security
oAuthClient(Required scopes:
https://api.egain.cloud/auth/.de...
)
Path
idstring, = 36 charactersrequired

id of object

Example:7b6c5fff-036e-4a40-b68a-a67c592fc079
Bodyapplication/json

Update participant

namestring, [ 1 .. 255 ] charactersrequired

Unique name for participant

typestringrequired

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

Enum:"custom_bot""egain_bot"
descriptionstring, [ 1 .. 1023 ] characters
activeboolean
Default:true
applicationobjectrequired
intentsobject(Intents)

Intents supported by bot.

optionsArray of objects, [ 1 .. 25 ] items(Attribute)
modifiedstring, (date-time)

Last modified time in GMT

PUT
/participants/{id}
curl -i -X PUT \
  https://api.egain.cloud/conversation/conversationmgr/v3/participants/7b6c5fff-036e-4a40-b68a-a67c592fc079 \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "custom_bot_participant",
    "type": "custom_bot",
    "active": true,
    "application": {
      "id": "9d091084-3ca8-4afc-97e1-8b0ad52fc38f"
    },
    "modified": "2021-03-06T21:16:36.838Z"
  }'

Responses

No Content

Response
No content