领导
Leads API提供了一个简单的接口来管理Leads。潜在客户代表对您的商品或服务感兴趣的个人或组织。您可以通过将组织分配给个人organization_name字段。
该API允许您创建，读取，删除和更新您的线索。您可以检索单个线索，以及所有线索的列表。
| 名字 | 只读 | 类型 | 描述 |
|---|---|---|---|
id |
真正的 | 数量 | 引线的唯一标识符。 |
creator_id |
真正的 | 数量 | 创建线索的用户的唯一标识符。 |
owner_id |
假 | 数量 | 当前拥有lead的用户的唯一标识符。 |
first_name |
假 | 字符串 | 引导者的名字。 |
last_name |
假 | 字符串 | 领导的姓。要求,除非organization_name字段。 |
organization_name |
假 | 字符串 | 领导的组织名称。要求,除非last_name字段。 |
状态 |
假 | 字符串 | 引线的状态。 |
source_id |
假 | 数量 | 源的唯一标识符。 |
标题 |
假 | 字符串 | 领导的职位名称。 |
描述 |
假 | 字符串 | 导致描述。 |
行业 |
假 | 字符串 | 组织的行业。 |
网站 |
假 | 字符串 | 领先的网站。 |
电子邮件 |
假 | 字符串 | 领导的邮件。 |
电话 |
假 | 字符串 | 领的电话号码。 |
移动 |
假 | 字符串 | Lead的手机号码。 |
传真 |
假 | 字符串 | 领导的传真号码。 |
推特 |
假 | 字符串 | Lead的推特账号。 |
脸谱网 |
假 | 字符串 | 铅的Facebook昵称。 |
linkedin |
假 | 字符串 | 领英的昵称。 |
skype |
假 | 字符串 | Lead的Skype昵称。 |
地址 |
假 | 地址 | 引路人的地址。欲了解更多有关地址对象看地址． |
标签 |
假 | 数组 | 引线的标记数组。详情见标签． |
custom_fields |
假 | 对象 | 自定义字段是附加到一个引线上的单个键-值对或附加到一个引线上的一组键-值对。详情见自定义字段． |
created_at |
真正的 | 字符串 | 创建日期和时间(UTC (ISO8601格式))。 |
updated_at |
真正的 | 字符串 | 上一次更新的UTC (ISO8601格式)日期和时间。 |
检索所有线索
得到/v2/领导
根据提供的参数返回用户可用的所有线索。
参数
| 名字 | 要求 | 类型 | 在 | 描述 |
|---|---|---|---|---|
页面 |
假 | 数量 | 查询 | 开始的页码。页编号从1开始，省略页面参数将返回第一页。 |
per_page |
假 | 数量 | 查询 | 每页要返回的记录数。默认限制为25可以返回的最大数目是One hundred.． |
sort_by |
假 | 字符串 | 查询 | 一个可以排序的领域。您也可以根据可过滤的自定义字段进行排序。示例:要按名为“external_id”的自定义字段排序，请使用? sort_by = custom_fields: external_id．支持自定义字段类型:数字，单行文本，下拉，多选择)。默认顺序为升序。如果要将排序顺序改为降序，请添加: desc去野外。例子:sort_by = last_name: desc．取值:id, first_name, last_name, organization_name, email, custom_fields, created_at, updated_at |
id |
假 | 字符串 | 查询 | 请求中要返回的先导id列表，以逗号分隔。 |
creator_id |
假 | 数量 | 查询 | 用户ID。返回该用户创建的所有线索。 |
owner_id |
假 | 数量 | 查询 | 用户ID。返回该用户拥有的所有线索。 |
source_id |
假 | 数量 | 查询 | 源Id。 |
first_name |
假 | 字符串 | 查询 | 引导者的名字。 |
last_name |
假 | 字符串 | 查询 | 领导的姓。 |
organization_name |
假 | 字符串 | 查询 | 领导的组织名称。 |
状态 |
假 | 字符串 | 查询 | 引线的状态。 |
电子邮件 |
假 | 字符串 | 查询 | 领导的电子邮件地址。 |
电话 |
假 | 字符串 | 查询 | 负责人的电话号码。 |
移动 |
假 | 字符串 | 查询 | 领跑者的手机号码。 |
地址(城市) |
假 | 字符串 | 查询 | 城市的名字。 |
地址(postal_code) |
假 | 字符串 | 查询 | 邮政编码 |
地址(状态) |
假 | 字符串 | 查询 | 国家/地区名称。 |
地址(国家) |
假 | 字符串 | 查询 | 国家的名字。 |
custom_fields |
假 | 字符串 | 查询 | 可过滤的自定义字段。示例:要查找具有名为“external_id”且值为“SKU01”的自定义字段的线索，使用以下方法:? custom_fields [external_id] = SKU01．支持自定义字段类型:数字，单行文本，下拉，多选择。自定义字段必须定义并具有滤过性的分配给他们的财产。 |
包容 |
可选 | 布尔 | 查询 | 指示应该如何组合过滤器。真正的value，默认值，使用AND逻辑。假value使用OR逻辑组合过滤器。 |
允许
- 代理
使用旋度
旋度-v -X GET https://api.getbase.com/v2/leads＼- h“接受:application / json”＼- h“授权:持票人ACCESS_TOKEN美元＂
示例响应
HTTP /1．1200好吧内容类型：application / json;charset = utf8内容语言：在｛“项目”：［｛“数据”：｛“id”：1，“creator_id”：1，“owner_id”：1，“first_name”：“马克”，“last_name”：“约翰逊”，“organization_name”：“设计服务公司”，“状态”：“新”，“source_id”：10，“标题”：“首席执行官”，“描述”："我是通过汤姆认识他的"，“行业”：“设计服务”，“网站”：“http://www.designservice.com”，“电子邮件”：＂(电子邮件保护)＂，“电话”：“508-778-6516”，“移动”：“508-778-6516”，“传真”：“+ 44-208-1234567”，“推特”：“mjohnson”，“facebook”：“mjohnson”，“linkedin”：“mjohnson”，“skype”：“mjohnson”，“地址”：｛“line1”：“史密斯街2726号”，“城市”：“海恩尼斯”，“postal_code”：“02601”，“状态”：“马”，“国家”：“我们”｝，“标签”：［“重要”］，“custom_fields”：｛“known_via”：“汤姆”｝，“created_at”：“2014 - 08 - 27 - t16:32:56z”，“updated_at”：“2014 - 08 - 27 - t16:32:56z”｝，“元”：｛“类型”：“领导”｝｝］，“元”：｛“类型”：“收集”，“数”：1，“链接”：｛“自我”：“http://api.getbase.com/v2/leads.json”｝｝｝
创建一个线索
帖子/v2/领导
创建一个新的线索。一个线索可以代表一个个人或一个组织。
参数
| 名字 | 要求 | 类型 | 在 | 描述 |
|---|---|---|---|---|
last_name |
真正的 | 字符串 | 身体 | 只有当线索是个人时才需要。company_name是空的。 |
organization_name |
真正的 | 字符串 | 身体 | 只有当领导是一个组织时才需要。last_name是空的。 |
first_name |
假 | 字符串 | 身体 | |
owner_id |
假 | 数量 | 身体 | 默认为创建引线的用户的唯一标识符。 |
状态 |
假 | 字符串 | 身体 | |
source_id |
假 | 数量 | 身体 | |
unqualified_reason_id |
假 | 数量 | 身体 | |
标题 |
假 | 字符串 | 身体 | |
描述 |
假 | 字符串 | 身体 | |
行业 |
假 | 字符串 | 身体 | |
网站 |
假 | 字符串 | 身体 | |
电子邮件 |
假 | 字符串 | 身体 | |
电话 |
假 | 字符串 | 身体 | |
移动 |
假 | 字符串 | 身体 | |
传真 |
假 | 字符串 | 身体 | |
推特 |
假 | 字符串 | 身体 | |
脸谱网 |
假 | 字符串 | 身体 | |
linkedin |
假 | 字符串 | 身体 | |
skype |
假 | 字符串 | 身体 | |
地址 |
假 | 地址 | 身体 | |
标签 |
假 | 数组 | 身体 | 如。(“重要”)） |
custom_fields |
假 | 对象 | 身体 | 如。{“known_via”:“汤姆”} |
允许
- 代理
使用旋度
旋度-v -X POST https://api.getbase.com/v2/leads＼- h“接受:application / json”＼- h“application / json内容类型:＼- h“授权:持票人ACCESS_TOKEN美元＂＼- d”{"数据":{“first_name”:“马克”,“last_name”:“约翰逊”,“organization_name”:“设计服务公司”，“source_id”:10“标题”:“首席执行官”,"description": "我是通过汤姆认识他的"“工业”:“设计服务”，“网站”:“http://www.designservice.com”,“电子邮件”:“(电子邮件保护)”,“电话”:“508-778-6516”,“移动”:“508-778-6516”,“传真”:“+ 44-208-1234567”,“twitter”:“mjohnson”,“facebook”:“mjohnson”,“linkedin”:“mjohnson”,“skype”:“mjohnson”,"地址":{“1号线”:史密斯街2726号，“城市”:“海恩尼斯”,“postal_code”:“02601”,“状态”:“妈”,“国家”:“我们”}，“标签”:[“重要”)," custom_fields ": {“known_via”:“汤姆”｝｝} '
示例响应
HTTP /1．1200好吧内容类型：application / json;charset = utf8内容语言：在｛“数据”：｛“id”：1，“creator_id”：1，“owner_id”：1，“first_name”：“马克”，“last_name”：“约翰逊”，“organization_name”：“设计服务公司”，“状态”：“新”，“source_id”：10，“标题”：“首席执行官”，“描述”："我是通过汤姆认识他的"，“行业”：“设计服务”，“网站”：“http://www.designservice.com”，“电子邮件”：＂(电子邮件保护)＂，“电话”：“508-778-6516”，“移动”：“508-778-6516”，“传真”：“+ 44-208-1234567”，“推特”：“mjohnson”，“facebook”：“mjohnson”，“linkedin”：“mjohnson”，“skype”：“mjohnson”，“地址”：｛“line1”：“史密斯街2726号”，“城市”：“海恩尼斯”，“postal_code”：“02601”，“状态”：“马”，“国家”：“我们”｝，“标签”：［“重要”］，“custom_fields”：｛“known_via”：“汤姆”｝，“created_at”：“2014 - 08 - 27 - t16:32:56z”，“updated_at”：“2014 - 08 - 27 - t16:32:56z”｝，“元”：｛“类型”：“领导”｝｝
检索单个线索[GET]
得到/v2/领导/：id
根据所提供的惟一潜在客户ID，返回用户可用的单个潜在客户。如果指定的线索不存在，此查询将返回错误。
参数
| 名字 | 要求 | 类型 | 在 | 描述 |
|---|---|---|---|---|
id |
真正的 | 数量 | 查询 | 引线的唯一标识符。 |
允许
- 代理
使用旋度
旋度-v -X GET https://api.getbase.com/v2/leads/1＼- h“接受:application / json”＼- h“授权:持票人ACCESS_TOKEN美元＂
示例响应
HTTP /1．1200好吧内容类型：application / json;charset = utf8内容语言：在｛“数据”：｛“id”：1，“creator_id”：1，“owner_id”：1，“first_name”：“马克”，“last_name”：“约翰逊”，“organization_name”：“设计服务公司”，“状态”：“新”，“source_id”：10，“标题”：“首席执行官”，“描述”："我是通过汤姆认识他的"，“行业”：“设计服务”，“网站”：“http://www.designservice.com”，“电子邮件”：＂(电子邮件保护)＂，“电话”：“508-778-6516”，“移动”：“508-778-6516”，“传真”：“+ 44-208-1234567”，“推特”：“mjohnson”，“facebook”：“mjohnson”，“linkedin”：“mjohnson”，“skype”：“mjohnson”，“地址”：｛“line1”：“史密斯街2726号”，“城市”：“海恩尼斯”，“postal_code”：“02601”，“状态”：“马”，“国家”：“我们”｝，“标签”：［“重要”］，“custom_fields”：｛“known_via”：“汤姆”｝，“created_at”：“2014 - 08 - 27 - t16:32:56z”，“updated_at”：“2014 - 08 - 27 - t16:32:56z”｝，“元”：｛“类型”：“领导”｝｝
更新线索
把/v2/领导/：id
更新潜在客户信息。如果指定的线索不存在，此查询将返回错误。
为了修改标记，您需要提供整个标记集。标签每次在请求中使用时都会被替换。
参数
| 名字 | 要求 | 类型 | 在 | 描述 |
|---|---|---|---|---|
id |
真正的 | 数量 | 查询 | 引线的唯一标识符。 |
owner_id |
假 | 数量 | 身体 | |
first_name |
假 | 字符串 | 身体 | 如。马克 |
last_name |
假 | 字符串 | 身体 | 如。约翰逊 |
organization_name |
假 | 字符串 | 身体 | 如。设计服务公司 |
状态 |
假 | 字符串 | 身体 | 如。不合格的 |
source_id |
假 | 数量 | 身体 | |
unqualified_reason_id |
假 | 数量 | 身体 | |
标题 |
假 | 字符串 | 身体 | 如。首席执行官 |
描述 |
假 | 字符串 | 身体 | 如。我是通过汤姆认识他的 |
行业 |
假 | 字符串 | 身体 | 如。设计服务 |
网站 |
假 | 字符串 | 身体 | 如。www.designservices.com |
电子邮件 |
假 | 字符串 | 身体 | 如。(电子邮件保护) |
电话 |
假 | 字符串 | 身体 | 如。508-778-6516 |
移动 |
假 | 字符串 | 身体 | 如。508-778-6516 |
传真 |
假 | 字符串 | 身体 | 如。+ 44-208-1234567 |
推特 |
假 | 字符串 | 身体 | 如。mjohnson |
脸谱网 |
假 | 字符串 | 身体 | mjohnson |
linkedin |
假 | 字符串 | 身体 | 如。mjohnson |
skype |
假 | 字符串 | 身体 | 如。mjohnson |
地址 |
假 | 地址 | 身体 | |
标签 |
假 | 数组 | 身体 | 为了修改，您需要提供整个集。如。(“重要”) |
custom_fields |
假 | 对象 | 身体 | 如。{“known_via”:“汤姆”} |
允许
- 代理
使用旋度
旋度-v -X PUT https://api.getbase.com/v2/leads/:id＼- h“接受:application / json”＼- h“application / json内容类型:＼- h“授权:持票人ACCESS_TOKEN美元＂＼- d”{"数据":{“标签”:[“重要”,“朋友”］｝} '
示例响应
HTTP /1．1200好吧内容类型：application / json;charset = utf8内容语言：在｛“数据”：｛“id”：1，“creator_id”：1，“owner_id”：1，“first_name”：“马克”，“last_name”：“约翰逊”，“organization_name”：“设计服务公司”，“状态”：“新”，“source_id”：10，“标题”：“首席执行官”，“描述”："我是通过汤姆认识他的"，“行业”：“设计服务”，“网站”：“http://www.designservice.com”，“电子邮件”：＂(电子邮件保护)＂，“电话”：“508-778-6516”，“移动”：“508-778-6516”，“传真”：“+ 44-208-1234567”，“推特”：“mjohnson”，“facebook”：“mjohnson”，“linkedin”：“mjohnson”，“skype”：“mjohnson”，“地址”：｛“line1”：“史密斯街2726号”，“城市”：“海恩尼斯”，“postal_code”：“02601”，“状态”：“马”，“国家”：“我们”｝，“标签”：［“重要”，“朋友”］，“custom_fields”：｛“known_via”：“汤姆”｝，“created_at”：“2014 - 08 - 27 - t16:32:56z”，“updated_at”：“2014 - 08 - 27 - t16:32:56z”｝，“元”：｛“类型”：“领导”｝｝
删除一条线索
删除/v2/领导/：id
删除已存在的潜在客户。如果指定的线索不存在，此查询将返回错误。该操作无法恢复。
参数
| 名字 | 要求 | 类型 | 在 | 描述 |
|---|---|---|---|---|
id |
真正的 | 数量 | 查询 | 引线的唯一标识符。 |
允许
- 代理
使用旋度
旋度-v -X DELETE https://api.getbase.com/v2/leads/1＼- h“授权:持票人ACCESS_TOKEN美元＂
示例响应
HTTP/1．1204没有内容
提出一个线索
帖子/v2/领导/插入
根据筛选器或一组筛选器的值，创建新的线索或更新现有线索。至少需要一个筛选器—查询参数。如果没有参数，请求将返回一个错误。
行为:
- 如果多个线索匹配一组过滤器，请求将返回一个错误- 409。
- 如果单个线索匹配，则更新现有线索
- 如果没有匹配的查询，则创建一个新的线索
请注意使用Upsert API，而不是Create或Update，以避免创建不必要的重复记录。如果您希望Sell携带外部系统id(存储为自定义字段)，也非常有用。
参数
| 名字 | 要求 | 类型 | 在 | 描述 |
|---|---|---|---|---|
creator_id |
假 | 数量 | 身体 | 用户ID。返回该用户创建的所有线索。 |
owner_id |
假 | 数量 | 身体 | 用户ID。返回该用户拥有的所有线索。 |
source_id |
假 | 数量 | 身体 | 源Id。 |
first_name |
假 | 字符串 | 身体 | 引导者的名字。 |
last_name |
假 | 字符串 | 身体 | 领导的姓。 |
organization_name |
假 | 字符串 | 身体 | 领导的组织名称。 |
状态 |
假 | 字符串 | 身体 | 引线的状态。 |
电子邮件 |
假 | 字符串 | 身体 | 领导的电子邮件地址。 |
电话 |
假 | 字符串 | 身体 | 负责人的电话号码。 |
移动 |
假 | 字符串 | 身体 | 领跑者的手机号码。 |
地址(城市) |
假 | 字符串 | 身体 | 城市的名字。 |
地址(postal_code) |
假 | 字符串 | 身体 | 邮政编码 |
地址(国家) |
假 | 字符串 | 身体 | 国家的名字。 |
custom_fields |
假 | 字符串 | 身体 | 可过滤的自定义字段。示例:要对具有名为“external_id”且值为“SKU01”的自定义字段的leads执行upsert，使用以下方法:? custom_fields [external_id] = SKU01．自定义字段必须定义并具有滤过性的分配给他们的财产。支持自定义字段类型:数字，单行文本，下拉，多选择。 |
包容 |
假 | 布尔 | 身体 | 指示应该如何组合过滤器。真正的value，默认值，使用AND逻辑。假value使用OR逻辑组合过滤器。 |
允许
- 代理
使用旋度
旋度-v -X POST https://api.getbase.com/v2/leads/upsert?custom_fields［external_id］＝SKU01＼- h“接受:application / json”＼- h“application / json内容类型:＼- h“授权:持票人ACCESS_TOKEN美元＂＼- d”{"数据":{"地址":{“第一行”:“橡树巷494号”}，" custom_fields ": {:“external_id SKU01”｝｝} '
示例响应
HTTP /1．1200好吧内容类型：application / json;charset = utf8内容语言：在｛“数据”：｛“id”：1，“creator_id”：1，“owner_id”：1，“first_name”：“马克”，“last_name”：“约翰逊”，“organization_name”：“设计服务公司”，“状态”：“新”，“标题”：“首席执行官”，“描述”："我是通过汤姆认识他的"，“行业”：“设计服务”，“网站”：“http://www.designservice.com”，“电子邮件”：＂(电子邮件保护)＂，“电话”：“508-778-6516”，“移动”：“508-778-6516”，“传真”：“+ 44-208-1234567”，“推特”：“mjohnson”，“facebook”：“mjohnson”，“linkedin”：“mjohnson”，“skype”：“mjohnson”，“地址”：｛“line1”：“橡树巷494号”，“城市”：“海恩尼斯”，“postal_code”：“02601”，“状态”：“马”，“国家”：“我们”｝，“标签”：［“重要”］，“custom_fields”：｛“external_id”：“SKU01”，“known_via”：“汤姆”｝，“created_at”：“2015 - 07 - 16 - t17:14:16z”，“updated_at”：“2014 - 08 - 27 - t16:32:56z”｝，“元”：｛“类型”：“领导”｝｝