Delete a User Type

Purpose

To delete the user type from a portal.

Endpoints

DELETE /settings/portals/{portal_name}/user_type/{user_type_id}

Request Details

Request URL

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

Header

Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52

Scope

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

Sample Request

Copiedcurl "https://www.zohoapis.com/crm/v5/settings/portals/ZohoTest17/user_type/1947281000000470169"
-X DELETE
-H "Authorization: Zoho-oauthtoken 1000.8cb99dxxxxxxxxxxxxx9be93.9b8xxxxxxxxxxxxxxxf"

Possible Errors

INVALID_DATAHTTP 400
The user type has users.
Resolution: You can delete a user type only after transferring the users to another user type. Refer to the Transfer users and delete user type API.
NO_PERMISSIONHTTP 403
The "Manage Portal" permission is disabled.
Resolution: Contact your administrator and set up the "Manage Portal" permission to be able to delete a user type from the portal.

Sample Response

Copied{
    "user_type": [
        {
            "code": "SUCCESS",
            "details": {
                "id": 1947281000000470169
            },
            "message": "Portal user type deleted successfully.",
            "status": "success"
        }
    ]
}