UpdateUser

UpdateUser updates a user as defined by the UpdateUserRequest.
Required Permissions: USER_EDIT (default)

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Body Params application/json

time_zone_override

object (TimeZoneWrapper)

time_zone_override

optional

User TimeZone with wrapper for nullable timezone

value

enum<string>

value

optional

Allowed values:

TIME_ZONE_AMERICA_PUERTO_RICOTIME_ZONE_AMERICA_NEW_YORKTIME_ZONE_AMERICA_INDIANAPOLISTIME_ZONE_AMERICA_CHICAGOTIME_ZONE_AMERICA_PHOENIXTIME_ZONE_AMERICA_DENVERTIME_ZONE_AMERICA_LOS_ANGELESTIME_ZONE_AMERICA_ANCHORAGETIME_ZONE_ASIA_MANILATIME_ZONE_ASIA_CALCUTTATIME_ZONE_ASIA_COLOMBOTIME_ZONE_PACIFIC_HONOLULUTIME_ZONE_CANADA_NEWFOUNDLANDTIME_ZONE_CANADA_ATLANTICTIME_ZONE_CANADA_CENTRALTIME_ZONE_CANADA_EAST_SASKATCHEWANTIME_ZONE_CANADA_EASTERNTIME_ZONE_CANADA_MOUNTAINTIME_ZONE_CANADA_PACIFICTIME_ZONE_CANADA_SASKATCHEWANTIME_ZONE_CANADA_YUKONTIME_ZONE_ETC_GREENWICHTIME_ZONE_ETC_UNIVERSALTIME_ZONE_EUROPE_LONDONTIME_ZONE_EUROPE_MADRIDTIME_ZONE_EUROPE_BERLINTIME_ZONE_EUROPE_BUCHARESTTIME_ZONE_AMERICA_MEXICO_CITYTIME_ZONE_MEXICO_BAJASURTIME_ZONE_MEXICO_BAJANORTETIME_ZONE_BRAZIL_ACRETIME_ZONE_BRAZIL_WESTTIME_ZONE_BRAZIL_EASTTIME_ZONE_BRAZIL_DENORONHATIME_ZONE_AUSTRALIA_DARWINTIME_ZONE_AUSTRALIA_ADELAIDETIME_ZONE_AUSTRALIA_SYDNEYTIME_ZONE_AUSTRALIA_BRISBANETIME_ZONE_AUSTRALIA_MELBOURNETIME_ZONE_AUSTRALIA_PERTHTIME_ZONE_PACIFIC_AUCKLANDTIME_ZONE_PACIFIC_CHATHAMTIME_ZONE_ASIA_SINGAPORETIME_ZONE_ASIA_JAPANTIME_ZONE_AMERICA_SANTIAGOTIME_ZONE_AMERICA_BOGOTATIME_ZONE_AMERICA_LIMA

default_app

enum<string>

default_app

optional

Default app the user starts on

Allowed values:

AGENT_APPORGANIZATION_MANAGEMENT_APPCUSTOMER_JOURNEY_SERVICES_APPLIST_MANAGEMENT_SERVICES_APPAGENT_MANAGER_APPNATURAL_LANGUAGE_COMPLIANCE_APPVOICE_ANALYTICS_APPSCRIPTS_APPROOM303_APPOMNI_BOSS_APPWFM_APPPAYMENTS_APPSUPPORT_APPBUSINESS_INTELLIGENCE_APPBACKOFFICE_APPSCORECARDS_APPDEV_TOOLS_APPLEARNING_CENTER_APPDELIVERY_SERVICE_APPPERFORMANCE_MANAGEMENT_APPTICKETS_APPAGENT_BETA_APPNEWSROOM_APPCONTACTMANAGER_APPKNOWLEDGE_BASE_APP

locale_preferences_override

object (LocalePreferences)

locale_preferences_override

optional

The override for the users locale preferences

operator_display_language

object (OperatorDisplayLanguage)

operator_display_language

optional

The display language in Operator for users of the organization.

operator_language_direction

enum<string>

operator_language_direction

optional

The direction of the language used in the organization.

Allowed values:

OPERATOR_LANGUAGE_DIRECTION_UNSPECIFIEDOPERATOR_LANGUAGE_DIRECTION_DEFAULTOPERATOR_LANGUAGE_DIRECTION_LEFT_TO_RIGHTOPERATOR_LANGUAGE_DIRECTION_RIGHT_TO_LEFT

language_tag

string

language_tag

deprecated

Display language in Operator for users of the organization.
Must be a valid language tag supported in Operator.
IETF BCP 47 - https://en.wikipedia.org/wiki/IETF_language_tag
DEPRECATED: use operator_display_language instead.

use_script_direction_right_to_left

boolean

use_script_direction_right_to_left

deprecated

The direction of the script in Operator used in the organization.
By default, it is set to false to indicate left-to-right.
DEPRECATED: use language_direction_preference instead.

default_currency

string

default_currency

optional

The default currency used in the organization.
Must be a valid currency code supported in Operator.
ISO 4217 - https://en.wikipedia.org/wiki/ISO_4217.

field_mask

string

field_mask

optional

List of all fields being updated

user_id

string

user_id

optional

first_name

string

first_name

optional

last_name

string

last_name

optional

partner_agent_id

string

partner_agent_id

optional

user_name

string

user_name

optional

user_caller_id

string

user_caller_id

deprecated

DEPRECATED: user_caller_id was previously optional,
if user_caller_id needs to be provided, use UpdateUserCallerId rpc

password_reset_required

boolean

password_reset_required

optional

agent_profile_group_id

string

agent_profile_group_id

optional

label_entities

array[object (Label) {5}]

label_entities

optional

A list of labels to assign to the user

name

string

name

optional

simply the name of the label.
'Team A', 'Medical', etc

description

string

description

optional

the description of the label.

color

string

color

optional

Hex color code of the label.

label_id

string

label_id

optional

Id of the label.

deleted

boolean

deleted

optional

whether or not the label is deleted.

string

optional

The users email

linkback_numbers

array[string]

linkback_numbers

optional

caller_ids

array[string]

caller_ids

optional

Example

{
    "time_zone_override": {
        "value": "TIME_ZONE_AMERICA_PUERTO_RICO"
    },
    "default_app": "AGENT_APP",
    "locale_preferences_override": {
        "operator_display_language": {
            "value": "string"
        },
        "operator_language_direction": "OPERATOR_LANGUAGE_DIRECTION_UNSPECIFIED",
        "language_tag": "string",
        "use_script_direction_right_to_left": true,
        "default_currency": "string"
    },
    "field_mask": "string",
    "user_id": "string",
    "first_name": "string",
    "last_name": "string",
    "partner_agent_id": "string",
    "user_name": "string",
    "user_caller_id": "string",
    "password_reset_required": true,
    "agent_profile_group_id": "string",
    "label_entities": [
        {
            "name": "string",
            "description": "string",
            "color": "string",
            "label_id": "string",
            "deleted": true
        }
    ],
    "email": "string",
    "linkback_numbers": [
        "string"
    ],
    "caller_ids": [
        "string"
    ]
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Request

Request samples

Responses