Zoho crm Logo

创建门户

目的

要为您的组织创建一个门户。

端点

  • POST /settings/portals

请求详情

请求 URL

{api-domain}/crm/{version}/settings/portals

标题

授权: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52

范围

scope=ZohoCRM.settings.clientportal.ALL
(或)
Scope=ZohoCRM.settings.clientportal.CREATE

示例请求

Copiedcurl "https://www.zohoapis.com/crm/v8/settings/portals"
-X POST
-H "Authorization: Zoho-oauthtoken 1000.8cb99dxxxxxxxxxxxxx9be93.9b8xxxxxxxxxxxxxxxf"
-d "@input.json"

输入 JSON

  • name字符串,必填

    门户的名称。请确保此名称唯一,且仅包含字母和数字。

样例输入

Copied{
    "portals": [
        {
            "name": "PortalsAPItest100"
        }
    ]
}

可能的错误

  • MANDATORY_NOT_FOUNDHTTP 400

    您尚未为门户指定名称。
    解决方案:门户名称为必填项。请确保在请求正文中包含键 "name"。

  • INVALID_DATAHTTP 400

    您已在请求正文中定义了门户名称。 解决方法 请指定门户名称。

  • PATTERN_NOT_MATCHEDHTTP 400

    门户名称包含特殊字符。
    解决方法: 门户名称只能使用字母和数字。

  • ALREADY_USEDHTTP 400

    门户名称已存在。
    解决方法: 门户名称必US须唯一。请使用不同的名称重试。

  • NO_PERMISSIONHTTP 403

    您没有“Manage Portal”或“Manage Portal Users”权限,或两者都没有。
    解决方案:请参阅响应中的“details”键,并联系您的管理员。

示例响应

Copied{
    "portals": [
        {
            "code": "SUCCESS",
            "details": {
                "name": "PortalsAPItest100"
            },
            "message": "Portal created successfully with given name.",
            "status": "success"
        }
    ]
}