- Overview
- What's New in V6?
- 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
- User Groups
- Tags
- Unsubscribe Links
- 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
- 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
Create a Portal
Purpose
To create a portal for your org.
Endpoints
Request Details
Request URL
{api-domain}/crm/{version}/settings/portals
Header
Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52
Scope
scope=ZohoCRM.settings.clientportal.ALL
(or)
Scope=ZohoCRM.settings.clientportal.CREATE
Sample Request
Copiedcurl "https://www.zohoapis.com/crm/v6/settings/portals"
-X POST
-H "Authorization: Zoho-oauthtoken 1000.8cb99dxxxxxxxxxxxxx9be93.9b8xxxxxxxxxxxxxxxf"
-d "@input.json"Input JSON
- namestring, mandatory
The name of the portal. Ensure that this name is unique and has only alphanumeric characters.
Sample Input
Copied{
"portals": [
{
"name": "PortalsAPItest100"
}
]
}Possible Errors
- MANDATORY_NOT_FOUNDHTTP 400
You have not specified a name for the portal.
Resolution: Portal's name is mandatory. Ensure that you have included the key "name" in the input body. - INVALID_DATAHTTP 400
You have defined portal name in the input body. Resolutions Specify portal name.
- PATTERN_NOT_MATCHEDHTTP 400
The portal name contains special characters.
Resolution: You can only use alphanumeric characters for the portal name. - ALREADY_USEDHTTP 400
The portal name already exists.
Resolution: The portal name must be unique. Try again with a different name. - NO_PERMISSIONHTTP 403
You do not have either "Manage Portal", "Manage Portal Users" permission or both.
Resolution: Refer to the "details" key in the response and contact your administrator.
Sample Response
Copied{
"portals": [
{
"code": "SUCCESS",
"details": {
"name": "PortalsAPItest100"
},
"message": "Portal created successfully with given name.",
"status": "success"
}
]
}© 2025, Zoho Corporation Pvt. Ltd. All Rights Reserved.