Zoho crm Logo

创建变量

目的

要在CRM中创建一个新变量。

端点

  • POST /settings/variables

请求详情

请求 URL

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

标题

授权: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52

范围

ZohoCRM.设置.变量.{operation_type}

可能的操作类型

ALL - 对变量数据的完全访问
CREATE - 创建变量数据

示例请求

Copiedcurl "https://www.zohoapis.com/crm/v8/settings/variables"
-X POST
-d @createvariables.json
-H "Authorization: Zoho-oauthtoken 1000.8cb99dxxxxxxxxxxxxx9be93.9b8xxxxxxxxxxxxxxxf"
Copiedvariable1 = Map();
variable1.put("name", "Variable99");
variable1.put("api_name", "Variable99");
variable1.put("variable_group", {"id":"692969000000981099"});
variable1.put("type", "integer");
variable1.put("value", "99");
variable1.put("description", "This denotes variable 9 description");

variable2 = Map();
variable2.put("name", "Variable22");
variable2.put("api_name", "Variable22");
variable2.put("variable_group", {"name":"Group2"});
variable2.put("type", "text");
variable2.put("value", "Hello");
variable2.put("description", "This denotes variable 2 description");

variables_list = List();
variables_list.add(variable1);
variables_list.add(variable2);
param = Map();
param.put("variables", variables_list);
	response = invokeurl
[
	url: "https://www.zohoapis.com/crm/v8/settings/variables"
	type: POST
	parameters: param.toString()
	connection:"crm_oauth_connection"
];
info response;

在请求中,"@createvariables.json"包含示例输入数据。

输入 JSON

要创建变量,请发送一个 POST 请求,其请求体包含以下属性:

  • Name string,必填

    指定要创建的变量的显示Name。该字段是唯一的。
    示例: 变量Name3

  • api_name string,必填

    指定在任何 API 请求中引用该变量时使用的名称。它是一个唯一字段。
    示例: MainVariable

  • type string,可选

    指定变量的数据类型。
    可能的取值: integer, text, percent, decimal, currency, date, datetime, email, phone, url, checkbox, textarea, long

  • variable_groupJSON object,必填

    指定变量必须所属的组。
    示例: {"id": 40000000047005} 或 {"name":"Group2"}

  • 值取决于类型,可选

    Specify the default value 为该变量。
    示例: 123

  • description string,可选

    指定该变量的简短描述。
    示例: 该变量的简短描述。

样例输入

Copied{
    "variables": [
       {
            "name": "Variable33",
            "api_name": "Variable33",
            "variable_group": {
                "id": "40000000047005"
            },
            "type": "integer",
            "value": 33,
            "description": "This denotes variable 3 description"
        },
       {
            "name": "Variable44",
            "api_name": "Variable44",
            "variable_group": {
                "name": "Group2"
            },
            "type": "text",
            "value": "Hello",
            "description": "This denotes variable 4 description"
        }
    ]
}

可能的错误

  • INVALID_REQUEST_METHODHTTP 400

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

  • AUTHORIZATION_FAILEDHTTP 400

    用户没有足够的权限添加变量
    解决方案: 用户没有添加变量的权限。请联系系统管理员。

  • PATTERN_NOT_MATCHEDHTTP 400

    请检查输入值是否正确
    解决方案:为“type”键指定的值不正确。请参阅输入 JSON 键并指定有效的输入。

  • INVALID_DATAHTTP 400

    无效数据
    解决方案: 指定的输入不正确。请参阅上面的输入 JSON 键部分,并指定有效的输入。

  • DUPLICATE_DATAHTTP 400

    重复数据
    解决方案: 您为一个或多个唯一字段指定了重复的值。请参阅 字段元数据 API 以了解唯一字段。

  • REQUIRED_PARAM_MISSINGHTTP 400

    缺少一个预期的 paRAMeter
    解决方案: 您未在输入中指定一个或多个必填字段。请参阅上面的 Input JSON Keys 部分,并在输入中指定所有必填字段。

  • OAUTH_SCOPE_MISMATCHHTTP 401

    未授权
    解决方案: 客户端没有ZohoCRM.settings.variables.CREATE 作用域。创建一个具有有效作用域的新客户端。请参阅上文的作用域部分。

  • NO_PERMISSIONHTTP 403

    没有权限创建记录
    解决方案:该用户没有创建变量的权限。请联系系统管理员。

  • INVALID_URL_PATTERNHTTP 404

    请检查您尝试访问的 URL 是否正确
    解决方法: 指定的请求 URL 不正确。请指定一个有效的请求 URL。请参阅上面的请求 URL 部分。

  • INTERNAL_ERRORHTTP 500

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

响应示例

Copied{
    "variables": [
       {
            "code": "SUCCESS",
            "details": {
                "id": "40000000047009"
            },
            "message": "variable added",
            "status": "success"
        },
       {
            "code": "SUCCESS",
            "details": {
                "id": "40000000047010"
            },
            "message": "variable added",
            "status": "success"
        }
    ]
}