Update User

put

{protocol}://{server}:{port}{basePath}/v1beta/accounts/{accountId}/users/{userId}

This API requires the Account Administrator role.

Updates a user.

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

userId
emailId

This operation will clear the value stored for any fields not present in the request.
For example, to remove a feature such as voice from a user you should omit the
voice field in the request. The same behavior applies to every field in the request.

When updating a user with a profileId, the field values in the user request will override any that are
also defined in the profile. For example, if the profile contains configuration for features and the user
request also contains features, the features defined in the user request will override those from the profile.

Changes to the fields:

roles
features

Will trigger asynchronous updates, the status of which should be monitored via /users:listStatuses.

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.

userId

string

required

length between 36 and 36

^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$

The unique 36 character internal id (uuid) that represents the user.

Body Params

User

A User can be an Agent, Supervisor or an Administrator.

organizationNodeId

string

required

length between 6 and 6

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

Unique Id for Account or Node where user get created

loginId

string

required

length ≤ 255

^[a-zA-Z\p{L}0-9+-_.]+(?:\.[a-zA-Z\p{L}0-9+-_.]+)*@(?:[a-zA-Z\p{L}0-9-]+\.)+[a-zA-Z\p{L}]{2,63}$

password

string

length ≤ 255

^(?=.{8,}$)(?=.*?[a-z])(?=.*?[A-Z])(?=.*?[0-9])(?=.*?\W).*$

lastName

string

required

length between 2 and 255

^[^<>\^@#]*$

Last name of User

firstName

string

required

length between 2 and 255

^[^<>\^@#]*$

First name of User

displayName

string

length between 2 and 510

^[^<>\^@#]*$

Display name of User

emailId

string

length between 5 and 255

^[a-zA-Z\p{L}0-9]+[a-zA-Z\p{L}0-9+\-_.]+(?:\.[a-zA-Z\p{L}0-9+\-_.]+)*@(?:[a-zA-Z\p{L}0-9-]+\.)+[a-zA-Z\p{L}]{2,63}$

Email Id of User

profileId

string

length between 6 and 6

^[a-zA-Z0-9\-\_\.\ ]+$

The unique 6 character internal id that represents the profile.

memberOfGroups

array of strings

length ≤ 50

List of the groups of which the user is member of.

memberOfGroups

ownedGroups

array of strings

length ≤ 50

List of the groups owned by the user.

ownedGroups

roles

array of objects

length ≤ 11

Roles assigned to user.

See the list of Available Roles.

roles

addresses

array of objects

length ≤ 5

List of the address added by user

addresses

accountAddresses

array of objects

length ≤ 4

List of the account addresses assigned to the user

accountAddresses

features

object

Features enabled in user

Headers

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

Language

Credentials

Bearer

JWT

URL

Loading…

Response

Choose an example:

application/json

application/problem+json

202Accepted

400Constraint Violation

401Unauthorized

403Forbidden

404Not Found

409Conflict

500Request processing failed