ALalianza
End User

Repurpose an existing user to be a different user (end user swap)

Use this endpoint to reuse an end user, along with their existing devices, telephone numbers and calling plans, for a new person. <BR> A new voicemail box is created, and call handling and call screening settings are reset. <BR> The new user's password is set to null. To reset the user password go <a href="#/~operation/End%20User/resetPassword_2">here.</a> <BR> Please note that the acting user cannot repurpose themselves.

put/v2/partition/{partitionId}/account/{accountId}/user/{userId}/repurpose

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

firstNamestring

Must be different than the existing name.

lastNamestring
emailAddressstring

Will be nullified when not present.

usernamestring

Will be nullified when not present.

blockEmailboolean

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.