客户联系人
接触对象
属性 | 类型 | 描述 |
---|---|---|
id |
整数 | 联系人的唯一ID。 |
客户端 |
对象 | 包含联系人的客户端id和名称的对象。 |
标题 |
字符串 | 联系人的标题。 |
first_name |
字符串 | 联系人的名字。 |
last_name |
字符串 | 联系人的姓。 |
电子邮件 |
字符串 | 联系人的电子邮件地址。 |
phone_office |
字符串 | 联系人的办公室电话号码。 |
phone_mobile |
字符串 | 联系人的手机号码。 |
传真 |
字符串 | 联系人的传真号码。 |
created_at |
datetime | 创建联系人的日期和时间。 |
updated_at |
datetime | 联系人最后更新的日期和时间。 |
需要的权限
您必须是具有创建和编辑客户端的权限的管理员或管理员,才能与/ v2 /联系人
端点。权限不足将导致403年被禁止的
状态码。
列出所有联系人
返回联系人列表。联系人按创建日期排序返回,最近创建的联系人出现在前面。
响应包含一个对象联系人
属性,该属性包含最多到的数组per_page
联系人。数组中的每个条目都是一个单独的联系人对象。如果没有更多可用的联系人,则生成的数组将为空。响应中包含了几个额外的分页属性,以简化对联系人的分页。
获得/ v2 /联系人
参数 | 类型 | 描述 |
---|---|---|
client_id |
整数 | 只返回属于具有给定ID的客户端的联系人。 |
updated_since |
datetime | 只返回自给定日期和时间以来更新过的联系人。 |
页面 |
整数 | 在分页中使用的页码。例如,如果您提出一个列表请求并收到2000条记录,您的后续呼叫可以包括页面= 2 检索列表的下一页。(默认值:1) |
per_page |
整数 | 每页要返回的记录数。取值范围为1 ~ 2000。(默认:2000) |
示例请求
curl "https://api.bob客服端下载harvestapp.com/v2/contacts" \ -H "授权:持有者$ACCESS_TOKEN" \ -H "收获帐户id: $ACCOUNT_ID" \ -H "User-Agent: MyApp (yourname@example.com)"
示例响应
<?xml version="1.0" encoding="UTF-8"?><联系人类型=“数组”>< >联系< id类型=“整数”>4706479< / id ><客户机id类型=“整数”>5735774< /客户机id ><标题>老板< /名称><直呼其名的>简< /直呼其名的><姓名>美国能源部< /姓名>< >邮件janedoe@example.com< / >邮件< phone-office >(203) 697 - 8885< / phone-office >< phone-mobile >(203) 697 - 8886< / phone-mobile >< >传真(203) 697 - 8887> < /传真<创建类型=“dateTime”>2013 - 08 - 12 - t15:30:14z< /创建><更新于类型=“dateTime”>2015 - 04 - 16 - t18:07:28z< /更新于>> < /联系< >联系< id类型=“整数”>4706453< / id ><客户机id类型=“整数”>5735776< /客户机id ><标题>经理< /名称><直呼其名的>理查德。< /直呼其名的><姓名>罗伊< /姓名>< >邮件richardroe@example.com< / >邮件< phone-office >(318) 515 - 5905< / phone-office >< phone-mobile >(318) 515 - 5906< / phone-mobile >< >传真(318) 515 - 5907> < /传真<创建类型=“dateTime”> < /创建><更新于类型=“dateTime”> < /更新于>> < /联系< / >接触
{“联系人”:【{“id”:4706479,“标题”:“所有者”,“first_name”:“简”,“last_name”:“母鹿”,“电子邮件”:“janedoe@example.com”,“phone_office”:“(203)697 - 8885”,“phone_mobile”:“(203)697 - 8886”,“传真”:“(203)697 - 8887”,“created_at”:“2017 - 06 - 26 t21:20:07z”,“updated_at”:“2017 - 06 - 26 t21:27:07z”,“客户端”: {“id”:5735774,“名称”:“ABC集团”}},{“id”:4706453,“标题”:“经理”,“first_name”:“理查德”,“last_name”:“羚羊”,“电子邮件”:“richardroe@example.com”,“phone_office”:“(318)515 - 5905”,“phone_mobile”:“(318)515 - 5906”,“传真”:“(318)515 - 5907”,“created_at”:“2017 - 06 - 26 t21:06:55z”,“updated_at”:“2017 - 06 - 26 t21:27:20z”,“客户端”: {“id”:5735776,“名称”:“123”产业}}],“per_page”:2000,“total_pages”:1,“total_entries”:2,“next_page”:零,“previous_page”:零,“页面”:1,“链接”: {“第一”:“https://api.bob客服端下载harvestapp.com/v2/contacts?page=1&per_page=2000”,“下一个”:零,“以前”:零,“最后一次”:“https://api.bob客服端下载harvestapp.com/v2/contacts?page=1&per_page=2000”}}
检索联系人
检索具有给定ID的联系人。返回一个联系人对象和200好了
提供有效标识符时的响应代码。
GET / v2 /联系人/ {CONTACT_ID}
示例请求
curl "https://api.bob客服端下载harvestapp.com/v2/contacts/4706479" \ -H "授权:持有者$ACCESS_TOKEN" \ -H "收获帐户id: $ACCOUNT_ID" \ -H "User-Agent: MyApp (yourname@example.com)"
示例响应
<?xml version="1.0" encoding="UTF-8"?><联系人类型=“数组”>< >联系< id类型=“整数”>4706479< / id ><客户机id类型=“整数”>5735774< /客户机id ><标题>老板< /名称><直呼其名的>简< /直呼其名的><姓名>美国能源部< /姓名>< >邮件janedoe@example.com< / >邮件< phone-office >(203) 697 - 8885< / phone-office >< phone-mobile >(203) 697 - 8886< / phone-mobile >< >传真(203) 697 - 8887> < /传真<创建类型=“dateTime”>2013 - 08 - 12 - t15:30:14z< /创建><更新于类型=“dateTime”>2015 - 04 - 16 - t18:07:28z< /更新于>> < /联系< / >接触
{“id”:4706479,“标题”:“所有者”,“first_name”:“简”,“last_name”:“母鹿”,“电子邮件”:“janedoe@example.com”,“phone_office”:“(203)697 - 8885”,“phone_mobile”:“(203)697 - 8886”,“传真”:“(203)697 - 8887”,“created_at”:“2017 - 06 - 26 t21:20:07z”,“updated_at”:“2017 - 06 - 26 t21:27:07z”,“客户端”: {“id”:5735774,“名称”:“ABC集团”}}
创建联系人
创建一个新的联系人对象。返回一个联系人对象和201年创建
调用成功时的响应代码。
POST / v2 /联系人
参数 | 类型 | 要求 | 描述 |
---|---|---|---|
client_id |
整数 | 要求 | 与此联系人关联的客户端ID。 |
标题 |
字符串 | 可选 | 联系人的标题。 |
first_name |
字符串 | 要求 | 联系人的名字。 |
last_name |
字符串 | 可选 | 联系人的姓。 |
电子邮件 |
字符串 | 可选 | 联系人的电子邮件地址。 |
phone_office |
字符串 | 可选 | 联系人的办公室电话号码。 |
phone_mobile |
字符串 | 可选 | 联系人的手机号码。 |
传真 |
字符串 | 可选 | 联系人的传真号码。 |
示例请求
curl "https://api.bob客服端下载harvestapp.com/v2/contacts" \ -H "Harvest-Account-Id: $ACCOUNT_ID" \ -H "User-Agent: MyApp (yourname@example.com)"\ -X POST \ -H "Content-Type: application/json" \ -d '{"client_id":5735776,"first_name":"George","last_name":"Frank","email":"georgefrank@example.com"}'
示例响应
<?xml version="1.0" encoding="UTF-8"?><联系人类型=“数组”>< >联系< id类型=“整数”>4706510< / id ><客户机id类型=“整数”>5735776< /客户机id ><标题>零< /名称><直呼其名的>乔治< /直呼其名的><姓名>弗兰克< /姓名>< >邮件georgefrank@example.com< / >邮件< phone-office > < / phone-office >< phone-mobile > < / phone-mobile ><传真> < /传真><创建类型=“dateTime”>2019 - 06 - 26 - t21:44:57z< /创建><更新于类型=“dateTime”>2019 - 06 - 26 - t21:44:57z< /更新于>> < /联系< / >接触
{“id”:4706510,“标题”:零,“first_name”:“乔治”,“last_name”:“弗兰克”,“电子邮件”:“georgefrank@example.com”,“phone_office”:"",“phone_mobile”:"",“传真”:"",“created_at”:“2019 - 06 - 26 t21:44:57z”,“updated_at”:“2019 - 06 - 26 t21:44:57z”,“客户端”: {“id”:5735776,“名称”:“123”产业}}
更新联系人
通过设置传递的参数值更新特定的联系人。任何未提供的参数将保持不变。返回一个联系人对象和200好了
调用成功时的响应代码。
补丁/ v2 /联系人/ {CONTACT_ID}
参数 | 类型 | 描述 |
---|---|---|
client_id |
整数 | 与此联系人关联的客户端ID。 |
标题 |
字符串 | 联系人的标题。 |
first_name |
字符串 | 联系人的名字。 |
last_name |
字符串 | 联系人的姓。 |
电子邮件 |
字符串 | 联系人的电子邮件地址。 |
phone_office |
字符串 | 联系人的办公室电话号码。 |
phone_mobile |
字符串 | 联系人的手机号码。 |
传真 |
字符串 | 联系人的传真号码。 |
示例请求
curl "https://api.bob客服端下载harvestapp.com/v2/contacts/4706510" \ -H "授权:持有者$ACCESS_TOKEN" \ -H "收获帐户id: $ACCOUNT_ID" \ -H "User-Agent: MyApp (yourname@example.com)"\ -X PATCH \ -H "Content-Type: application/json" \ -d '{"title":"Owner"}'
示例响应
<联系人类型=“数组”>< >联系< id类型=“整数”>4706510< / id ><客户机id类型=“整数”>5735776< /客户机id ><标题>老板< /名称><直呼其名的>乔治< /直呼其名的><姓名>弗兰克< /姓名>< >邮件georgefrank@example.com< / >邮件< phone-office > < / phone-office >< phone-mobile > < / phone-mobile ><传真> < /传真><创建类型=“dateTime”>2019 - 06 - 26 - t21:44:57z< /创建><更新于类型=“dateTime”>2019 - 06 - 26 - t21:44:57z< /更新于>> < /联系< / >接触
{“id”:4706510,“标题”:“所有者”,“first_name”:“乔治”,“last_name”:“弗兰克”,“电子邮件”:“georgefrank@example.com”,“phone_office”:"",“phone_mobile”:"",“传真”:"",“created_at”:“2019 - 06 - 26 t21:44:57z”,“updated_at”:“2019 - 06 - 26 t21:44:57z”,“客户端”: {“id”:5735776,“名称”:“123”产业}}
删除联系人
删除联系人。返回一个200好了
调用成功时的响应代码。
删除/ v2 /联系人/ {CONTACT_ID}