Update a user

patch

https://rls.congacloud.com/api/user-management/v1/users/{userId}

Updates the user information for a specific user.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

userId

string

required

User ID

Body Params

Details to be updated in the user model. Note: To see a list of supported numbers, dates, and currency formats, use the Timezone and Locale APIs and the Currency Format APIs.

FirstName

string | null

The user's first name

LastName

string | null

The user's last name

string | null

The user's email address

Role

object

Timezone

string | null

The user's time zone ID. For example: UTC

Note: To see a list of supported time zones, use the Timezone and Locale APIs.

LocaleName

string | null

The user's locale name. For example: en-US

Note: To see a list of supported locales, use the Timezone and Locale APIs.

LocaleDecimalSymbol

string | null

The user's decimal symbol. For example: .

Note: To see a list of supported decimal symbols, use the Timezone and Locale APIs.

LocaleDigitGroup

string | null

The user's digit group. For example: 123’456’789,00

Note: To see a list of supported digit groups, use the Timezone and Locale APIs.

LocaleDigitGroupingSymbol

string | null

The user's digit grouping symbol. For example: ,

Note: To see a list of supported digit grouping symbols, use the Timezone and Locale APIs.

LocaleNegativeNumberFormat

string | null

The user's negative number format. For example: (n)

Note: To see a list of supported negative number formats, use the Timezone and Locale APIs.

LocaleLongDateFormat

string | null

The user's long date format. For example: dddd, MMMM dd, yyyy

Note: To see a list of supported long date formats, use the Timezone and Locale APIs.

LocaleShortDateFormat

string | null

The user's short date format. For example: dd/MM/yyyy

Note: To see a list of supported short date formats, use the Timezone and Locale APIs.

LocaleTimeFormat

string | null

The user's time format. For example: h:mm tt

Note: To see a list of supported time formats, use the Timezone and Locale APIs.

Currency

string | null

The user's currency. For example: USD.

Note: To see a list of currencies, use the Currency API.

PositiveCurrencyFormat

string | null

The user's positive currency format. For example: $n.

Note: To see a list of supported positive currency formats, use the Currency Format API.

NegativeCurrencyFormat

string | null

The user's negative currency format. For example: -$n.

Note: To see a list of supported negative currency formats, use the Currency Format API.

IsSuspended

boolean | null

Indicates whether the user is suspended or not.

Alias

string | null

The user's alias name

Language

string | null

The user's language. For example: en-IN

Address

string | null

The user's postal address. This parameter is raw text with no structure or sub-fields. For example: 13699 Via Varra, Broomfield, CO 80020 United States

PhoneNumber

string | null

The user's phone number

ExternalId

string | null

The user's unique record identifier from the external system

UserName

string | null

The user's unique username

CustomProperties

object | null

User object specific custom field(s) For example: You want to update two custom fields (CustomField1_c and BooleanField_c) on the User object. See the payload example below for reference. {"CustomProperties": {"CustomField1_c": "12334", "BooleanField_c": "true"}

FederationId

string | null

Determines of user type. For example: External, Community

UserType

string

enum

Allowed:

Headers

content-type

string

enum

Defaults to application/json

Generated from available request content types

Allowed:

Responses

400

Bad Request

403

Forbidden

404

Not Found

500

Internal Server Error

200Success