Change User's Status

Purpose

To change the status of a user in the portal.

Endpoints

Request Details

Request URL

{api-domain}/crm/{version}/settings/portals/{portal_name}/user_type/{user_type_id}/users/{personality_id}/actions/change_status

Header

Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52

Scope

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

Parameter

  • activeboolean, mandatory

    true activates the user in the portal, and false deactivates the user in the portal.

Sample Request

Copiedcurl "https://www.zohoapis.com/crm/v6/settings/portals/ZohoTest17/user_type/1947281000000470169/users/1306462000000665004/actions/change_status?active=false"
-H "Authorization: Zoho-oauthtoken 1000.8cb99dxxxxxxxxxxxxx9be93.9b8xxxxxxxxxxxxxxxf"
-X PUT

Possible Errors

  • INVALID_DATAHTTP 400

    The user's record is in the recycle bin. So, you cannot change the status of this user.

  • ALREADY_ACTIVATEDHTTP 400

    The user is already active.

  • 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.

  • LIMIT_EXCEEDEDHTTP 403

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

Sample Response

Copied{
    "change_status": [
        {
            "code": "SUCCESS",
            "details": {
                "personality_id": "1306462000000665004"
            },
            "message": "Status of the user changed successfully.",
            "status": "success"
        }
    ]
}