自定义字段
后创建自定义字段在用户界面中,您可以使用自定义字段API来管理每种资源类型的自定义字段。你不能通过API创建新的自定义字段。
自定义字段类型
每个自定义字段都有一个定义的类型,它有相应的值格式:
类型 | 值的格式 | 例子 |
---|---|---|
地址 |
地址 | |
保龄球 |
布尔 | 真正的 |
日期 |
字符串 | “4/27/2016” |
datetime |
字符串 | “4/28/2016 6点” |
电子邮件 |
字符串 | (电子邮件保护) |
列表 |
对象 | {" id ": 1,“名字”:“ABC”} |
multi_select_list |
数组 | [{"id":1, "name":"ABC"},{"id":3, "name":"XYZ"}] |
数量 |
字符串 | “123.45” |
电话 |
字符串 | |
字符串 |
字符串 | |
文本 |
字符串 | |
url |
字符串 | http://example.com |
JSON格式
的名字 | 类型 | 只读 | 描述 |
---|---|---|---|
id |
数量 | 真正的 | 自定义字段的唯一标识符。 |
的名字 |
字符串 | 真正的 | 自定义字段的名称。 |
类型 |
字符串 | 假 | 自定义字段的类型。 |
选择 |
数组 | 假 | 表示可用于此特定自定义字段的选项(仅适用于multi_select_list 而且列表 ). |
for_company |
保龄球 | 假 | 联系人:公司是否需要自定义字段(仅适用于resource_type =联系 ). |
for_contact |
保龄球 | 假 | 联系人:个人是否需要自定义字段(仅适用于resource_type =联系 ). |
created_at |
字符串 | 真正的 | 以UTC (ISO8601格式)创建自定义字段的日期和时间。 |
updated_at |
字符串 | 真正的 | 上一次更新的UTC (ISO8601格式)日期和时间。 |
检索自定义字段
得到/v2/:resource_type/custom_fields
返回与指定资源类型关联的所有自定义字段。
参数
的名字 | 类型 | 在 | 要求 | 描述 |
---|---|---|---|---|
resource_type |
字符串 | 查询 | 真正的 | 指定应为其返回自定义字段的类型。可能的值:引领 ,联系 ,交易 ,prospect_and_customer |
允许
- 代理
使用旋度
旋度-v -X GET https://api.getbase.com/v2/contact/custom_fields\
- h“接受:application / json”\
- h“授权:持票人ACCESS_TOKEN美元"
示例响应
HTTP /1.1200好吧
内容类型:application / json;charset = utf8
内容语言:在
{
“项目”:[
{
“数据”:{
“id”:1,
“名称”:“Url”,
“created_at”:“2016 - 12 - 13 - t16:42:44z”,
“updated_at”:“2018 - 05 - 02 - t09:27:54z”,
“for_organisation”:真正的,
“for_contact”:真正的,
“类型”:“url”,
“选择”:零
},
“元”:{
“类型”:“custom_field”
}
},
{
“数据”:{
“id”:2,
“名称”:“部门名称”,
“created_at”:“2017 - 02年- 15 - t10:32:57z”,
“updated_at”:“2018 - 09 - 17 t11:24:51z”,
“for_organisation”:假,
“for_contact”:真正的,
“类型”:“字符串”,
“选择”:零
},
“元”:{
“类型”:“custom_field”
}
},
{
“数据”:{
“id”:3.,
“名称”:“工业集团”,
“created_at”:“2018 - 06 - 20 t14:43:49z”,
“updated_at”:“2018 - 07 - 04 - t08:04:06z”,
“for_organisation”:真正的,
“for_contact”:真正的,
“类型”:“列表”,
“选择”:[
{
“id”:1,
“名称”:“资本货物”
},
{
“id”:2,
“名称”:“多元化金融服务”
},
{
“id”:3.,
“名称”:“食品、饮料及烟草”
}
]
},
“元”:{
“类型”:“custom_field”
}
}
],
“元”:{
“类型”:“收集”,
“数”:3.,
“链接”:{
}
}
}