Create Account

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.

SecurityoAuthClient

Request

Request Body schema: application/json

name required	string [ 1 .. 255 ] characters Unique name for account
description	string [ 1 .. 1023 ] characters
active	boolean Default: true
address required	string [ 1 .. 255 ] characters Account ID like email address, phone numbers.
required	object
	object (CaseManagement)
required	object (ChatConfigurations)
	Array of objects (Attribute) [ 1 .. 10 ] items

Responses

201

Created

400

Bad Request

401

Unauthorized

403

Forbidden

500

Internal server error

post/accounts

Request samples

Payload
curl
JavaScript
Node.js

application/json

This is sample payload for BYOC channel account

{"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"
}
}
}

Response samples

application/json

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