Create Participant

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.

SecurityoAuthClient
Request
Request Body schema: application/json

Create 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
Responses
201

Created

400

Bad Request

401

Unauthorized

403

Forbidden

500

Internal server error

post/participants
Request samples
application/json
{
  • "name": "custom_bot_participant",
  • "type": "custom_bot",
  • "active": true,
  • "application": {
    },
  • "intents": {
    }
}
Response samples
application/json
{
  • "id": "45a095f4-d0ee-4220-a689-22b541c58f61"
}