Zoho crm Logo

创建角色

目的

要向您的组织添加新角色。

端点

  • POST /settings/roles

请求详情

请求 URL

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

标题

授权:Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52

范围

ZohoCRM.设置.角色.{operation_type}

可能的操作类型

ALL - 对角色数据的完整访问权限
CREATE - 创建角色数据

示例请求

Copiedcurl "https://www.zohoapis.com/crm/v8/settings/roles"
-X POST
-H "Authorization: Zoho-oauthtoken 1000.8cb99dxxxxxxxxxxxxx9be93.9b8xxxxxxxxxxxxxxxf"

请求 JSON

  • name string,必填

    表示该角色的显示名称。

  • reporting_toJSON object,可选

    表示在角色层级中高于当前角色的角色的唯一 ID 和名称。

  • descriptionstring,可选

    表示该角色的描述(如果有)。

  • share_with_peersBoolean,可选

    表示具有当前角色的用户是否有权限共享记录。
    可能的取值
    false: 具有当前角色的用户无法与其他用户共享记录。这是默认值。
    true: 具有当前角色的用户可以与其他用户共享记录。

样例输入

Copied{
    "roles": [
        {
            "name": "Product Manager",
            "reporting_to": "4150868000000225013",
            "description": "Schedule and manage resources",
            "share_with_peers": true
        }
    ]
}

可能的错误

  • INVALID_REQUEST_METHODHTTP 400

    HTTP 请求方法类型无效
    解决方案: 您为访问 API URL 指定了无效的 HTTP 方法。请指定有效的请求方法。请参阅本页开头的端点部分。

  • AUTHORIZATION_FAILEDHTTP 400

    用户没有足够的权限读取角色
    解决方案:该用户没有权限获取角色数据。请联系您的系统管理员。

  • INVALID_DATAHTTP 400

    提供的 ID 似乎无效或已被删除
    解决方案: 请求输入中指定的角色 ID 无效。请指定有效的角色 ID。

  • INVALID_DATAHTTP 400

    Role 名称不应包含以下特殊字符:#
    解决方案: Role 名称不得包含任何特殊字符。请指定有效的 Role 名称。

  • DUPLICATE_DATAHTTP 400

    由于已存在同名角色,添加角色失败
    解决方案:在请求中指定唯一的角色名称。

  • MANDATORY_NOT_FOUNDHTTP 400

    未找到必填字段
    解决方案:在请求输入中指定角色的名称。

  • LICENSE_LIMIT_EXCEEDEDHTTP 400

    请求超出了您的许可限制
    解决方案:请联系您的管理员。

  • OAUTH_SCOPE_MISMATCHHTTP 401

    用于发起此 API 调用的访问令牌不具备所需的作用域
    解决方案:为此 API 生成包含所需作用域的新访问令牌。有关所需作用域列表,请参阅本页开头的作用域部分。

  • NO_PERMISSIONHTTP 403

    读取权限被拒绝
    解决方法: 该用户没有读取角色数据的权限。请联系系统管理员。

  • INVALID_URL_PATTERNHTTP 404

    请求 URL 不正确
    解决方案: 请指定有效的请求 URL。有关更多详细信息,请参阅本页开头的 请求 URL 部分。

  • INTERNAL_ERRORHTTP 500

    内部服务器错误
    解决方案:服务器中出现了意外且未处理的异常。请联系支持团队。

示例响应

Copied{
    "roles": [
        {
            "code": "SUCCESS",
            "details": {
                "id": "5843104000002870001"
            },
            "message": "Role added",
            "status": "success"
        }
    ]
}