Skip to content
Conversation APIs
/
/
/
Create Participant

Create Participant

Request

Overview

This API allow you to register participant New Account API process flow: Authenticiation > Client Application > Participant > Channel > Orchestration > Account

Scope

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

Security
oAuthClient(Required scopes:
https://api.egain.cloud/auth/.de...
)
Bodyapplication/json

Create 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)
POST
/participants
curl -i -X POST \
  https://api.egain.cloud/conversation/conversationmgr/v3/participants \
  -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"
    },
    "intents": {
      "intent": [
        {
          "value": "order_complaints",
          "displayValue": "Order Complaints"
        },
        {
          "value": "sales_enquiries",
          "displayValue": "Sales Enquiries"
        }
      ]
    }
  }'

Responses

Created

Bodyapplication/json
idstring, = 36 characters

UUID generated for the object.

Response
{
  "id": "45a095f4-d0ee-4220-a689-22b541c58f61"
}