属性 |
类型 |
描述 |
id |
整数 |
联系人的唯一ID。 |
客户端 |
对象 |
包含联系人的客户端id和名称的对象。 |
标题 |
字符串 |
联系人的标题。 |
first_name |
字符串 |
联系人的名字。 |
last_name |
字符串 |
联系人的姓。 |
电子邮件 |
字符串 |
联系人的电子邮件地址。 |
phone_office |
字符串 |
联系人的办公室电话号码。 |
phone_mobile |
字符串 |
联系人的手机号码。 |
传真 |
字符串 |
联系人的传真号码。 |
created_at |
datetime |
创建联系人的日期和时间。 |
updated_at |
datetime |
联系人最后更新的日期和时间。 |
需要的权限
您必须是具有创建和编辑客户端的权限的管理员或管理员,才能与/ v2 /联系人
端点。权限不足将导致403年被禁止的
状态码。
返回联系人列表。联系人按创建日期排序返回,最近创建的联系人出现在前面。
响应包含一个对象联系人
属性,该属性包含最多到的数组per_page
联系人。数组中的每个条目都是一个单独的联系人对象。如果没有更多可用的联系人,则生成的数组将为空。响应中包含了几个额外的分页属性,以简化对联系人的分页。
参数 |
类型 |
描述 |
client_id |
整数 |
只返回属于具有给定ID的客户端的联系人。 |
updated_since |
datetime |
只返回自给定日期和时间以来更新过的联系人。 |
页面 |
整数 |
在分页中使用的页码。例如,如果您提出一个列表请求并收到2000条记录,您的后续呼叫可以包括页面= 2 检索列表的下一页。(默认值:1) |
per_page |
整数 |
每页要返回的记录数。取值范围为1 ~ 2000。(默认:2000) |
示例请求
我们有一组API请求邮递员这样就很容易验证了。点击这里了解更多!
curl "https://api.bob客服端下载harvestapp.com/v2/contacts" \ -H "授权:持有者$ACCESS_TOKEN" \ -H "收获帐户id: $ACCOUNT_ID" \ -H "User-Agent: MyApp (yourname@example.com)"
示例响应
检索具有给定ID的联系人。返回一个联系人对象和200好了
提供有效标识符时的响应代码。
GET / v2 /联系人/ {CONTACT_ID}
示例请求
我们有一组API请求邮递员这样就很容易验证了。点击这里了解更多!
curl "https://api.bob客服端下载harvestapp.com/v2/contacts/4706479" \ -H "授权:持有者$ACCESS_TOKEN" \ -H "收获帐户id: $ACCOUNT_ID" \ -H "User-Agent: MyApp (yourname@example.com)"
示例响应
创建一个新的联系人对象。返回一个联系人对象和201年创建
调用成功时的响应代码。
参数 |
类型 |
要求 |
描述 |
client_id |
整数 |
要求 |
与此联系人关联的客户端ID。 |
标题 |
字符串 |
可选 |
联系人的标题。 |
first_name |
字符串 |
要求 |
联系人的名字。 |
last_name |
字符串 |
可选 |
联系人的姓。 |
电子邮件 |
字符串 |
可选 |
联系人的电子邮件地址。 |
phone_office |
字符串 |
可选 |
联系人的办公室电话号码。 |
phone_mobile |
字符串 |
可选 |
联系人的手机号码。 |
传真 |
字符串 |
可选 |
联系人的传真号码。 |
示例请求
我们有一组API请求邮递员这样就很容易验证了。点击这里了解更多!
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"}'
示例响应
通过设置传递的参数值更新特定的联系人。任何未提供的参数将保持不变。返回一个联系人对象和200好了
调用成功时的响应代码。
补丁/ v2 /联系人/ {CONTACT_ID}
参数 |
类型 |
描述 |
client_id |
整数 |
与此联系人关联的客户端ID。 |
标题 |
字符串 |
联系人的标题。 |
first_name |
字符串 |
联系人的名字。 |
last_name |
字符串 |
联系人的姓。 |
电子邮件 |
字符串 |
联系人的电子邮件地址。 |
phone_office |
字符串 |
联系人的办公室电话号码。 |
phone_mobile |
字符串 |
联系人的手机号码。 |
传真 |
字符串 |
联系人的传真号码。 |
示例请求
我们有一组API请求邮递员这样就很容易验证了。点击这里了解更多!
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"}'
示例响应
删除联系人。返回一个200好了
调用成功时的响应代码。
删除/ v2 /联系人/ {CONTACT_ID}
示例请求
我们有一组API请求邮递员这样就很容易验证了。点击这里了解更多!
curl "https://api.bob客服端下载harvestapp.com/v2/contacts/4706510" \ -H "授权:持有者$ACCESS_TOKEN" \ -H "收获帐户id: $ACCOUNT_ID" \ -H "User-Agent: MyApp (yourname@example.com)"\ -x删除