Update a User

patch

https://api.web1on1.chat/v2/users/{user_id}

You may edit a user using this action. It takes a (possibly partial) JSON
object containing one or more of the user attributes.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

user_id

number

required

ID of the User, or the string 'me' to return the current user.

Body Params

familyName

string

Family name or surname. In the U.S. and most of Europe, the last name of an User. This can be used along with givenName instead of the displayName property.

givenName

string

Given name. In the U.S. and most of Europe, the first name of a User. This can be used along with familyName instead of the displayName property.

additionalName

string

An additional name for a User, can be used for a middle name.

displayName

string

Name of the User as it will be displayed in user interfaces. If not provided, this will be composed by concatenating givenName, additionalName and familyName.

string

required

Email address of the User, used to log in.

phone

string

User telephone number.

password

string

avatar

string

Avatar URL for the User.

organization

string

The ID of the organization the user belongs to. Must be the organization that the current API user is an admin for (default) or one of its sub-organizations.

role

string

enum

Defaults to agent

The role of the agent within the organization.

Allowed:

settings

object

User preferences.

200OK