Update Organization User

Update Organization User

Performs partial update, if a field is specified in the request it will be updated

(*)This parameter is mandatory only if its optional parent attribute is defined. Click here for more information.

Request Body Parameters:

ParameterTypeMandatoryDescriptionExample
<customAttribute1><customAttribute1Type>falseRegular custom attribute 1 value
<customAttributeN><customAttributeNType>falseRegular custom attribute N value
_addressobjectfalse
_address.address1stringfalseAn address11 Main St.
_address.address2stringfalseAn address's specificsEntry B, Apartment 1
_address.citystringfalseA cityBoston
_address.countryCodestringtrue(*)A 2-letter country code defined in ISO-3166US
_address.statestringfalseA stateMassachusetts
_address.zipCodestringfalseA zipcode02101
_dateOfBirthstringfalseA UTC date in the ISO-8601 format2007-12-20
_descriptionstringfalseA description, can be up to 5000 characters longLorem Ipsum
_emailstringfalseAn email address in the RFC-5322 specification[email protected]
_employeeIdstringfalse
_genderstringfalseA persons gender Values:MALE,FEMALE,UNDISCLOSEDFEMALE
_localestringfalseLocale in the following format: {language-ISO639}-{countryCode-ISO3166} lowercase.en-us
_mfaobjectfalse
_mfa.enabledbooleantrue(*)Is mfa enabled in login
_mfa.expirationInMinutesintegerfalseMfa expiration in minutes5
_nameobjectfalse
_name.firstNamestringtrue(*)A person's first nameJohn
_name.lastNamestringtrue(*)A person's last nameSmith
_ownerOrganizationobjectfalse
_ownerOrganization.idstringtrue(*)A UUID formatted string3fa85f64-5717-4562-b3fc-2c963f66afa6
_phonestringfalseAn E.164 formatted phone number+12345678901
Path Parameters:
ParameterTypeMandatoryDescriptionExample
idstringtrueOrganization User ID that needs to be updated3fa85f64-5717-4562-b3fc-2c963f66afa6

This API requires PROTECTED_API permission(s).

Path Params
uuid
required

Organization User ID that needs to be updated

Body Params
_name
object
string

A description, can be up to 5000 characters long

string

An email address in the RFC-5322 specification

string

An E.164 formatted phone number

string

Locale in the following format: {language-ISO639}-{countryCode-ISO3166} lowercase.

string
enum

A persons gender

Allowed:
string

A UTC date in the ISO-8601 format

_address
object
_mfa
object
string
_ownerOrganization
object
Responses

Language
Credentials
Bearer
JWT
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json