- Overview
- What's New in V8?
- Changelog
- Open API Specification 3.0.0 (OAS)
- API Directory
- API Collection
- APIs and References
- OAuth
- API Limits and Credits
- Compliance
- Zoho CRM SDKs
- Metadata APIs
- Customization
- Process Automation
- Security control
- Roles
- Profiles
- Territories
- GETTerritories
- POSTTerritories
- PUTTerritories
- DELETETerritories
- POSTTransfer and Delete Territories
- GETChild Territories of a Territory
- GETTerritories Assigned
- GETAssociated User Count
- GETRetrieve User details Associated with a Territory
- PUTAssociate Users with Territory
- POSTRemove Territories of Records
- POSTAssign Territories to Records
- DELETEDisassociate Users from Territory
- Export Audit Log
- Portals
- Data Sharing
- Company Settings
- Zia
- Core APIs
- Records
- Merge Records
- Share Records
- Mail Merge
- Services
- Appointments
- Appointments Rescheduled History
- Fields Attachments
- Meeting Cancel
- Notes
- Mass Actions
- Related Records
- External ID
- Emails
- Subforms
- Linking Modules
- Others
- Bulk APIs
- Composite API
- Query API
- Notification APIs
Delete User from the Portal
Purpose
To delete a user from a portal.
Endpoints
- DELETE /settings/portals/{portal_name}/user_type/{user_type_id}/users
Request Details
Request URL
{api-domain}/crm/{version}/settings/portals/{portal_name}/user_type/{user_type_id}/users
Header
Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52
Scope
scope=ZohoCRM.settings.clientportal.ALL
(or)
Scope=ZohoCRM.settings.clientportal.DELETE
Parameter
- personality_idsmandatory
Comma-separated IDs of the users you want to delete from the portal. Note that you can specify up to 499 IDs in the request, after which the system schedules a job to delete the users.
Sample Request
Copiedcurl "https://www.zohoapis.com/crm/v8/settings/portals/ZohoTest17/user_type/1947281000000470169/users?personality_ids=1306462000000659009"
-X DELETE
-H "Authorization: Zoho-oauthtoken 1000.8cb99dxxxxxxxxxxxxx9be93.9b8xxxxxxxxxxxxxxxf"Possible Errors
- INVALID_DATAHTTP 400
The user is already deleted, the user does not belong to that user type, or the user does not belong to that portal.
- 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": "Portal user deleted successfully.",
"status": "success"
}
]
}© 2025, Zoho Corporation Pvt. Ltd. All Rights Reserved.