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
Copied
Input JSON
- namestring, mandatory
The name of the portal. Ensure that this name is unique and has only alphanumeric characters.
Sample Input
Copied
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