Update Account

put

{protocol}://{server}{basePath}/accounts/{accountId}

This API requires the Account Administrator role.

Updates an account. This is a complete replacement of the existing Account.

Changes to the fields:

name
features

Will trigger asynchronous updates for 'name','features' the status of which should be monitored via /accounts:listStatuses.

The following fields must be unique otherwise a HTTP 409 Conflict will be returned:

name

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

accountId

string

required

length between 6 and 6

^[a-zA-Z]{6}$

The unique 6 character internal id that represents the customer account.

Body Params

Account Update request object

An Account represents the following

A customer that subscribes to an Avaya service.
An Avaya customer can manage the Account. These customers use a share of resources and features allocated to their Account.

name

string

required

length between 1 and 255

^(?=.*[a-zA-Z0-9\p{L}])[a-zA-Z0-9\p{L}(){};,:'^+<>&£@$¥€`~?#%+*"\\=\[\]\-\_\.\!\|\ ]+$

Name of the account. Unique in the solution.

domains

array of objects

required

length ≤ 50

domains*

emergencyEmailAddresses

array of strings

length ≤ 10

emergencyEmailAddresses

accountSize

int32

required

≥ 1

Maximum number of users that can be provisioned for an Account. The max value for this field is configured at a solution level. An Account Administrator can not modify this field for their own Account.

description

string

length between 0 and 1024

Description of the account.

addresses

array of objects

length ≤ 50

addresses

accountProperties

array of objects

length ≤ 50

accountProperties

organizationNodeTypes

array of objects

length ≤ 50

Model of the account's organization structure. For example, Organization -> Location -> Department -> Team

organizationNodeTypes

profiles

array of objects

length ≤ 200

profiles

features

object

Features associated to the account

countryCode

string

length between 2 and 2

Country code of the Account

timezone

string

length between 2 and 256

Timezone of the Account

Headers

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

Language

Credentials

URL

Loading…

Response

Choose an example:

application/json

application/problem+json

202Account update request accepted

400Constraint Violation

401Unauthorized

403Forbidden

404Not Found

409Conflict

500All other application errors