Transfer Users of a User Type

Purpose

To transfer the users of a user type to another user type in a portal.

Endpoints

Request Details

Request URL

{api-domain}/crm/{version}/settings/portals/{portal_name}/user_type/{user_type_id}/users/action/transfer

Header

Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52

Scope

scope=ZohoCRM.settings.clientportal.ALL
(or)
Scope=ZohoCRM.settings.clientportal.UPDATE

Parameters
  • transfer_Tomandatory

    The ID of the user type to which you want to transfer the users.

  • personality_idsmandatory

    Comma-separated IDs of the users you want to transfer to the new user type.

Sample Request

Copiedcurl "https://www.zohoapis.com/crm/v5/settings/portals/ZohoTest17/user_type/1947281000000470169/users/action/transfer?transfer_To=1306462000001857001&personality_ids=1306462000000659009"
-H "Authorization: Zoho-oauthtoken 1000.8cb99dxxxxxxxxxxxxx9be93.9b8xxxxxxxxxxxxxxxf"
-X POST

Possible Errors

  • INVALID_DATAHTTP 400
    • Invalid personality ID. Either the personality does not belong to any portal user or it does not belong to this user type, or the user type is invalid.
      Resolution: Specify the correct personality ID.
    • You are trying to transfer the users to custom user type.
      Resolution: you can only transfer users to the custom user type.
  • REQUIRED_PARAM_MISSINGHTTP 400
    • You have not specified either transfer_To or personality_ids.
      Resolution:transfer_To or personality_ids are mandatory parameters.
  • LICENSE_LIMIT_EXCEEDEDHTTP 403

    You have exceeded the license limit for portals for your org.
    Resolution: Contact your administrator or support@zohocrm.com to purchase user type add-on.

  • NO_PERMISSIONHTTP 403

    The "Client Portal User" permission is disabled.
    Resolution: Contact your administrator and set up the "Client Portal User" to transfer the users.

Sample Response

Copied{
    "users": [
        {
            "code": "SUCCESS",
            "details": {
                "personality_id": "1306462000000659009"
            },
            "message": "User has been transferred successfully",
            "status": "success"
        }
    ]
}