Update account

Overview

This APIs allows you to update an existing Conversation Manager account.

Scope

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

SecurityoAuthClient
Request
path Parameters
id
required
string = 36 characters

id of object

Example: 7b6c5fff-036e-4a40-b68a-a67c592fc079
Request Body schema: application/json

Update account

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
modified
string <date-time>

Last modified time in GMT

Responses
204

No Content

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal server error

put/accounts/{id}
Request samples
application/json
{
  • "name": "order_account",
  • "address": "123456789",
  • "modified": "2021-03-28T14:29:01.516Z",
  • "channel": {
    },
  • "chatConfigurations": {
    }
}
Response samples
application/json

Required attribute is missing in payload

{
  • "code": "400-143",
  • "developerMessage": "Required attribute is missing in the request body: <attribute>"
}