使用配置文件的外部ID
外部ID在Zendesk中用作附加标识符,例如员工编亚博号、客户参考编号或来自其他系统的用户ID。一个亚博Zendesk用户只能有一个唯一的外部ID。它是Zendesk用户的可选属性,也是概要文件的标识符类型。亚博这意味着可以使用外部ID将配置文件关联到Zendesk用户亚博.外部ID值不区分大小写。
请注意:标识符类型external_id
概要文件中的保留标识符类型是电子邮件
,脸谱网
,phone_number
,推特
.
本文描述了几种场景,其中可以使用外部ID将概要文件与Zendesk用户记录关联起来。亚博
使用外部ID创建新的Zende亚博sk用户和配置文件
创建一个新的配置文件和链接的Zendesk用户记录亚博概要文件的API.在请求负载中包括可选属性和标识符类型。要了解有关创建配置文件的详细信息,请参见创建概要文件.
例子
在本例中,根据标识符API创建或更新概要文件endpoint用于创建配置文件和Zendesk用户。亚博
请求标识符参数
bike_shop:客户:external_id:ch105
请求体
{
“配置文件”:{
“标识符”:[
{
“类型”:“external_id”,
“价值”:“ch105”
},
{
“类型”:“电子邮件”,
“价值”:"(电子邮件保护)"
}
],
“名称”:“克莱尔·霍尔特”
}
}
响应
{
“配置文件”:{
“id”:“01 efbg6rd3tgwscatkef4zydzf”,
“user_id”:“418109427253”,
“源”:“bike_shop”,
“类型”:“客户”,
“名称”:“克莱尔·霍尔特”,
“属性”:{},
“标识符”:[
{
“类型”:“external_id”,
“价值”:“ch105”
},
{
“类型”:“电子邮件”,
“价值”:"(电子邮件保护)"
}
],
“created_at”:“2020 - 08 - 10 - t06:16:30z”,
“updated_at”:“2020 - 08 - 10 - t06:16:30z”
}
}
一个配置文件和Zendesk亚博用户记录创建与名称“克莱尔霍尔特”,电子邮件(电子邮件保护)外部ID为“ch105”。
为没有外部ID的Zendesk用户创建配置文件亚博
如果Zendesk用户记录上没有定义外部ID,则可以使用亚博概要文件的API来创建或修改概要文件,并向概要文件和Zendesk用户记录添加外部ID。亚博
例子
用户亚博ID为“418149471354”的Zendesk用户记录没有外部ID。使用根据用户ID创建或更新配置文件端点,一个新的配置文件被创建并关联到Zendesk用户。亚博
请求用户ID参数
418149471354
请求标识符参数
bike_shop:客户:电子邮件:(电子邮件保护).com
请求体
{
“配置文件”:{
“标识符”:[
{
“类型”:“external_id”,
“价值”:“jb001”
},
{
“类型”:“电子邮件”,
“价值”:"(电子邮件保护)"
}
],
“名称”:“James Blunt”
}
}
响应
{
“配置文件”:{
“id”:“01 efb7cpeyf9fskhccrw9ckzsc”,
“user_id”:“418149471354”,
“源”:“bike_shop”,
“类型”:“客户”,
“名称”:“James Blunt”,
“属性”:{},
“标识符”:[
{
“类型”:“external_id”,
“价值”:“jb001”
},
{
“类型”:“电子邮件”,
“价值”:"(电子邮件保护)"
}
],
“created_at”:“2020 - 08 - 10 - t03:42:27z”,
“updated_at”:“2020 - 08 - 10 - t03:45:18z”
}
}
创建一个新的配置文件并与Zendesk用户相关联。亚博请求有效负载中的外部ID“jb001”被添加到概要文件和用户记录中。
使用外部ID为现有Zendesk用户创建配置文件亚博
您可以向概要文件添加外部ID,以将其链接到Zendesk用户记录。亚博当Zendes亚博k用户记录有定义的外部ID,但关联的概要文件没有时,可以添加匹配的外部ID。
例子
在这个例子中,Zendesk用户记录有一个亚博外部ID“abc123”,没有关联的配置文件。
属性创建一个新的概要文件按标识符创建或更新配置文件端点。请求有效负载中的外部ID(粗体部分)与Zendesk用户的外部ID匹配。亚博
请求路径参数
laserbeam_videos:客户:external_id:abc123
请求体
{
“配置文件”:{
“标识符”:[
{
“类型”:“external_id”,
“价值”:“abc123”
},
{
“类型”:“电子邮件”,
“价值”:"(电子邮件保护)"
}
],
“名称”:“简”
}
}
响应
{
“配置文件”:{
“id”:“01 ef0tq676barzznpzjsw7wnjp”,
“user_id”:“403500523153”,
“源”:“laserbeam_videos”,
“类型”:“默认”,
“名称”:“简”,
“属性”:{},
“标识符”:[
{
“类型”:“external_id”,
“价值”:“abc123”
},
{
“类型”:“电子邮件”,
“价值”:"(电子邮件保护)"
}
],
“created_at”:“2020 - 08 - 06 - t02:48:35z”,
“updated_at”:“2020 - 08 - 10 - t02:59:30z”
}
}
创建一个新的概要文件,并使用请求有效负载中定义的外部ID“abc123”与Zendesk用户关亚博联。
更新Zendesk用户外部ID时的配置文件亚博
命令可以更改Zendesk用户记录上的外亚博部ID支持用户API.如果Zen亚博desk用户的外部ID被更改并且与关联概要文件的外部ID不匹配,则可以使用概要文件的API把方法。
例子
概要文件有一个外部ID“12345678”。但是,关联的Zendesk用户的外部ID被更改为亚博“abc123”创建或更新用户API.
这个概要文件的external_id
标识符类型将更新为匹配external_id
属性的用户根据用户ID API创建或更新配置文件.请求标识符参数指定external_id: 1234545678
用于要更新的概要文件。
请求用户ID参数
018429223153
请求标识符参数
laserbeam_videos:默认的:external_id:12345678
请求体
{
“配置文件”:{
“标识符”:[
{
“类型”:“external_id”,
“价值”:“abc123”
}
]
“名称”:“简”
}
}
响应
{
“配置文件”:{
“id”:“02 b2en9bm781ezabcpc5mamc40”,
“user_id”:“4018429223153”,
“源”:“laserbeam_videos”,
“类型”:“客户”,
“名称”:“简”,
“属性”:{},
“标识符”:[
{
“类型”:“external_id”,
“价值”:“abc123”
}
],
“created_at”:“2020 - 08 - 06 - t02:48:35z”,
“updated_at”:“2020 - 08 - 06 - t02:48:35z”
}
}
概要文件在请求体中使用外部ID“abc123”进行更新,它与Zendesk用户记录的外部ID相匹配。亚博