ALalianza
End User

Patch end user

Use to update a end user. <span hidden>Refer to <a href="endUser.html#patch-end-user">patching an end user</a> for details.</span>

patch/v2/partition/{partitionId}/account/{accountId}/user/{userId}

Request

Path parameters

accountIdstring required

ID of account, refers to <a href="#/~schema/Account">account.id</a>

partitionIdstring required

ID of partition, refers to <a href="#/~schema/PartitionX">partition.id</a>

userIdstring required

ID of end user, refers to <a href="#/~schema/EndUserV2X">endUserV2X.id</a>

Request body

object required

Json containing the fragment of the end user object to be updated.

Example request

{
  "languageTag": "fr-CA"
}

Response

Successful operation

idstring
usernamestring

If the userProductPlan is ADVANCED or PROFESSIONAL, do not use an email as a username as this will result in loss of access to the softphone client.

firstNamestring
lastNamestring
emailAddressstring

Must be a valid email address

mustChangePasswordboolean
languageTagstring

<a href="https://www.iana.org/assignments/language-subtag-registry/language-subtag-registry">RFC-5646 Language tag</a>. Refer to <a href="#/~operation/Reference%20Resources/getLanguages">supported languages</a> for a list of supported values.

partitionIdstring
accountIdstring
timeZone'US/Samoa' | 'US/Hawaii' | 'US/Alaska' | 'US/Pacific' | 'US/Arizona' | 'US/Mountain' | 'US/Central' | 'US/Eastern' | 'America/St_Thomas' | 'Canada/Pacific' | 'Canada/Mountain' | 'Canada/Central' | 'Canada/Eastern' | 'Canada/Atlantic' | 'Canada/Newfoundland' required
extensionstring
newCppIdstring
voicemailBoxIdstring
endUserType'ADMIN' | 'ADVANCED_ADMIN' | 'BASIC_ADMIN' | 'STANDARD' | 'STANDARD_ADMIN' | 'SUPER_ADMIN'
userProductPlan'STANDARD' | 'ADVANCED' | 'PROFESSIONAL'
softphoneClientType'STRETTO' | 'CYMBUS'
pinLockedOutboolean
welcomeEmailSentstring date-time
blockEmailboolean
allowPortalAccessboolean
tagsstring

Changes

No recorded changes to this operation across all 1 revision of this API.