Update a Portal
Purpose
To update a portal's name in your org.
Endpoints
Request Details
Request URL
{api-domain}/crm/{version}/settings/portals/{portal_name}
Header
Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52
Scope
scope=ZohoCRM.settings.clientportal.ALL
(or)
Scope=ZohoCRM.settings.clientportal.UPDATE
Sample Request
Copiedcurl "https://www.zohoapis.com/crm/v4/settings/portals/PortalsAPItest100"
-X PUT
-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": "PortalsAPItest200"
}
]
}
Possible Errors
- 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": "PortalsAPItest200"
},
"message": "Portal renamed successfully with given name.",
"status": "success"
}
]
}