PUT - User Group ID Update

Moves the specified User to another Group under the same Enterprise.

Parameters

  • user_id (str): Target user ID of the user you would like to move

  • new_group_id (str): Target Group ID you would like to move the user to

  • evaluate_only (bool): Runs without actually moving user, just provides error codes.

Returns

  • Dict: Information about the User, alongside the new updated group ID

How To Use:

my_api.users.put_user_group_id_update(
    "[email protected]",
    "[email protected]",
    False
)

Example Data Returned (Formatted)

{
    "serviceProviderId": "ServiceProv",
    "groupId": "GRPID",
    "userId": "[email protected]",
    "lastName": "John",
    "firstName": "Doe",
    "callingLineIdLastName": "John",
    "callingLineIdFirstName": "Doe",
    "hiraganaLastName": "John",
    "hiraganaFirstName": "Doe",
    "language": "English",
    "timeZone": "America/New_York",
    "timeZoneDisplayName": "(GMT-04:00) (US) Eastern Time",
    "defaultAlias": "[email protected]",
    "countryCode": "1",
    "allowVideo": true,
    "callingLineIdPhoneNumber": "",
    "phoneNumber": "",
    "extension": "",
    "domain": "thephones.com",
    "endpointType": "none",
    "aliases": [],
    "accessDeviceEndpoint": {
        "contacts": []
    },
    "trunkAddressing": {
        "trunkGroupDeviceEndpoint": {
            "contacts": []
        }
    },
    "department": {
        "serviceProviderId": "",
        "groupId": "",
        "name": ""
    },
    "emailAddress": "",
    "nationalPrefix": "",
    "phoneNumberActivated": false,
    "isEnterprise": true,
    "passwordExpiresDays": "-2147483648"
}

Last updated

Was this helpful?