Skip to content
Conversation APIs
/
Conversation Manager
/
/Account

Account

Use this API to create the Conversation Account for Conversation Manager.

Operations

Create Account

Request

Overview

Use this API to create a Conversation Account for the Conversation Manager. New Account API process flow: Authentication > 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

Register new account

namestring, [ 1 .. 255 ] charactersrequired

Unique name for account

descriptionstring, [ 1 .. 1023 ] characters
activeboolean
Default:true
addressstring, [ 1 .. 255 ] charactersrequired

Account ID like email address, phone numbers.

channelobjectrequired
caseManagementobject(CaseManagement)
chatConfigurationsobject(ChatConfigurations)required
attributesArray of objects, [ 1 .. 10 ] items(Attribute)
POST
/accounts
curl -i -X POST \
  https://api.egain.cloud/conversation/conversationmgr/v3/accounts \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "order_account",
    "address": "123456789",
    "channel": {
      "id": "45a095f4-d0ee-4220-a689-22b541c58f67"
    },
    "chatConfigurations": {
      "timeout": 30,
      "defaultLanguage": "en-US",
      "onAgentUnavailability": "off_hours",
      "allowLogoutWithOpenChats": false,
      "allowQueueTransferOnAgentUnavailability": false,
      "orchestration": {
        "id": "c37e975f-6b2f-490f-9cac-dfa05499f744"
      },
      "entryPoint": {
        "id": "1001"
      }
    }
  }'

Responses

Created

Bodyapplication/json
idstring, = 36 characters

UUID generated for the object.

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