- Overview
- What's New in V7?
- Changelog
- API Directory
- API Collection
- OAuth Authentication
- OAuth Scopes
- API Limits
- Multi DC Support
- Increase API Credits
- Customize API Usage Notification
- GDPR Compliance
- HIPAA Compliance
- API Dashboard
- HTTP Request Methods
- Status Codes
- Zoho CRM SDKs
- Metadata APIs
- Modules
- Fields
- Layouts
- Related Lists
- Profiles
- Custom View
- Roles
- Global Picklists
- 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
- Scoring Rules
- Variables
- Map Dependency
- Duplicate Check Option
- Data Enrichment
- Create Export Audit Log
- User Groups
- Tags
- Unsubscribe Links
- Cadences
- Pipeline
- Wizards
- Assignment Rules
- Templates
- User's Unavailability
- Portals
- Fiscal Year
- Business Hours
- Holidays
- Record Locking Configuration
- Shift Hours
- Entity APIs
- Organization
- Users
- Records
- Related Records
- Records APIs using External ID
- Related Records Using External ID
- Merge Records
- List of Available APIs
- Features
- Meeting Cancel
- Linking Modules
- Subforms
- Contact Roles
- Photos and Attachments
- Mass Update
- Mass Delete
- Currencies
- Files
- Share
- Fields Attachments
- Recycle Bin
- Change Owner
- Mass Change Owner
- Emails
- Blueprint
- Notes
- Bulk APIs
- Composite API
- Notification APIs
- Query API
Change User's Status
Purpose
To change the status of a user in the portal.
Request Details
Request URL
{api-domain}/crm/{version}/settings/portals/{portal_name}/user_type/{user_type_id}/users/{user_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/v7/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"
}
]
}
© 2025, Zoho Corporation Pvt. Ltd. All Rights Reserved.