创建变量
目的
在CRM中创建一个新变量。
请求URL
https://www.zohoapis.com.cn/crm/v2/settings/variables
请求方法
POST
范围
scope=ZohoCRM.settings.variables.{operation_type}
可能的操作类型 |
---|
ALL - 完全访问变量数据 CREATE - 创建变量数据 |
属性规范
要创建变量,发送一个POST请求,请求体包含以下属性:
Key名称 | 类型 | 描述 | 示例 | 必填 |
---|---|---|---|---|
name | 文本 | 这是将要创建的变量的显示名称。这是一个唯一字段。 | VariableName3 | 是 |
api_name | 文本 | 这是在任何API请求中引用变量的名称。这是一个唯一字段。 | MainVariable | 是 |
type | 文本 | 这是变量的数据类型。 | 整型 | 否 |
variable_group | JSON对象 | 这是变量应该属于的组。 | {"id": 40000000047005} 或 {"name":"Group2"} | 是 |
value | 取决于变量的类型。 | 这是变量的初值。 | 123 | 否 |
description | 文本 | 变量的简短描述。 | 变量的简短描述。 | 否 |
备注:
变量数据类型创建后不能更改。
只有当创建变量时才能创建变量组。
在创建变量时,如果指定的变量组已经存在,则只需将该变量添加到该组中。
如果指定的变量组不存在,则创建一个新组,并将变量添加到该组中。
示例请求
curl "https://www.zohoapis.com.cn/crm/v2/settings/variables"
-X POST
-H "Authorization: Zoho-oauthtoken 1000.8cb99dxxxxxxxxxxxxx9be93.9b8xxxxxxxxxxxxxxxf"
示例输入
{
"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"
}
]
}
示例响应
{
"variables": [
{
"code": "SUCCESS",
"details": {
"id": "40000000047009"
},
"message": "variable added",
"status": "success"
},
{
"code": "SUCCESS",
"details": {
"id": "40000000047010"
},
"message": "variable added",
"status": "success"
}
]
}