lianja / Support API / Merge End Users
Back to Collection Items
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
loHttp = createobject("CkHttp")
loHttp.BasicAuth = .T.
loHttp.Login = "login"
loHttp.Password = "password"
// Use this online tool to generate code from sample JSON: Generate Code to Create JSON
// The following JSON is sent in the request body.
// {
// "user": {
// "name": "<string>",
// "email": "<string>",
// "custom_role_id": "<integer>",
// "external_id": "<string>",
// "identities": [
// {
// "type": "<string>",
// "value": "<string>"
// },
// {
// "type": "<string>",
// "value": "<string>"
// }
// ],
// "organization": {
// "name": "<string>"
// },
// "organization_id": "<integer>",
// "role": "<string>"
// }
// }
loJson = createobject("CkJsonObject")
loJson.UpdateString("user.name","<string>")
loJson.UpdateString("user.email","<string>")
loJson.UpdateString("user.custom_role_id","<integer>")
loJson.UpdateString("user.external_id","<string>")
loJson.UpdateString("user.identities[0].type","<string>")
loJson.UpdateString("user.identities[0].value","<string>")
loJson.UpdateString("user.identities[1].type","<string>")
loJson.UpdateString("user.identities[1].value","<string>")
loJson.UpdateString("user.organization.name","<string>")
loJson.UpdateString("user.organization_id","<integer>")
loJson.UpdateString("user.role","<string>")
loHttp.SetRequestHeader("Content-Type","application/json")
loHttp.SetRequestHeader("Accept","application/json")
loSbRequestBody = createobject("CkStringBuilder")
loJson.EmitSb(loSbRequestBody)
loResp = loHttp.PTextSb("PUT","https://example.zendesk.com/api/v2/users/:user_id/merge",loSbRequestBody,"utf-8","application/json",.F.,.F.)
if (loHttp.LastMethodSuccess = .F.) then
? loHttp.LastErrorText
release loHttp
release loJson
release loSbRequestBody
return
endif
loSbResponseBody = createobject("CkStringBuilder")
loResp.GetBodySb(loSbResponseBody)
loJResp = createobject("CkJsonObject")
loJResp.LoadSb(loSbResponseBody)
loJResp.EmitCompact = .F.
? "Response Body:"
? loJResp.Emit()
lnRespStatusCode = loResp.StatusCode
? "Response Status Code = " + str(lnRespStatusCode)
if (lnRespStatusCode >= 400) then
? "Response Header:"
? loResp.Header
? "Failed."
release loResp
release loHttp
release loJson
release loSbRequestBody
release loSbResponseBody
release loJResp
return
endif
release loResp
// Sample JSON response:
// (Sample code for parsing the JSON response is shown below)
// {
// "user": {
// "name": "<string>",
// "active": "<boolean>",
// "alias": "<string>",
// "chat_only": "<boolean>",
// "created_at": "<string>",
// "custom_role_id": "<integer>",
// "default_group_id": "<integer>",
// "details": "<string>",
// "email": "<string>",
// "external_id": "<string>",
// "iana_time_zone": "<string>",
// "id": "<integer>",
// "last_login_at": "<string>",
// "locale": "<string>",
// "locale_id": "<integer>",
// "moderator": "<boolean>",
// "notes": "<string>",
// "only_private_comments": "<boolean>",
// "organization_id": "<integer>",
// "phone": "<string>",
// "photo": {
// "dolorea1": false,
// "deserunt3": 95124319.10825741
// },
// "remote_photo_url": "<string>",
// "report_csv": "<boolean>",
// "restricted_agent": "<boolean>",
// "role": "<string>",
// "role_type": "<integer>",
// "shared": "<boolean>",
// "shared_agent": "<boolean>",
// "shared_phone_number": "<boolean>",
// "signature": "<string>",
// "suspended": "<boolean>",
// "tags": "<array>",
// "ticket_restriction": "<string>",
// "time_zone": "<string>",
// "two_factor_auth_enabled": "<boolean>",
// "updated_at": "<string>",
// "url": "<string>",
// "user_fields": {
// "nostrudacc": -12929960.546221554,
// "in_80e": 25167751.960886702,
// "proident_e2": true,
// "voluptate_98": -58995022
// },
// "verified": "<boolean>"
// }
// }
// Sample code for parsing the JSON response...
// Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
lcName = loJResp.StringOf("user.name")
lcActive = loJResp.StringOf("user.active")
lcAlias = loJResp.StringOf("user.alias")
lcChat_only = loJResp.StringOf("user.chat_only")
lcCreated_at = loJResp.StringOf("user.created_at")
lcCustom_role_id = loJResp.StringOf("user.custom_role_id")
lcDefault_group_id = loJResp.StringOf("user.default_group_id")
lcDetails = loJResp.StringOf("user.details")
lcV_Email = loJResp.StringOf("user.email")
lcExternal_id = loJResp.StringOf("user.external_id")
lcIana_time_zone = loJResp.StringOf("user.iana_time_zone")
lcId = loJResp.StringOf("user.id")
lcLast_login_at = loJResp.StringOf("user.last_login_at")
lcLocale = loJResp.StringOf("user.locale")
lcLocale_id = loJResp.StringOf("user.locale_id")
lcModerator = loJResp.StringOf("user.moderator")
lcNotes = loJResp.StringOf("user.notes")
lcOnly_private_comments = loJResp.StringOf("user.only_private_comments")
lcOrganization_id = loJResp.StringOf("user.organization_id")
lcPhone = loJResp.StringOf("user.phone")
llDolorea1 = loJResp.BoolOf("user.photo.dolorea1")
lcDeserunt3 = loJResp.StringOf("user.photo.deserunt3")
lcRemote_photo_url = loJResp.StringOf("user.remote_photo_url")
lcReport_csv = loJResp.StringOf("user.report_csv")
lcRestricted_agent = loJResp.StringOf("user.restricted_agent")
lcRole = loJResp.StringOf("user.role")
lcRole_type = loJResp.StringOf("user.role_type")
lcV_Shared = loJResp.StringOf("user.shared")
lcShared_agent = loJResp.StringOf("user.shared_agent")
lcShared_phone_number = loJResp.StringOf("user.shared_phone_number")
lcSignature = loJResp.StringOf("user.signature")
lcSuspended = loJResp.StringOf("user.suspended")
lcTags = loJResp.StringOf("user.tags")
lcTicket_restriction = loJResp.StringOf("user.ticket_restriction")
lcTime_zone = loJResp.StringOf("user.time_zone")
lcTwo_factor_auth_enabled = loJResp.StringOf("user.two_factor_auth_enabled")
lcUpdated_at = loJResp.StringOf("user.updated_at")
lcV_Url = loJResp.StringOf("user.url")
lcNostrudacc = loJResp.StringOf("user.user_fields.nostrudacc")
lcIn_80e = loJResp.StringOf("user.user_fields.in_80e")
llProident_e2 = loJResp.BoolOf("user.user_fields.proident_e2")
lnVoluptate_98 = loJResp.IntOf("user.user_fields.voluptate_98")
lcVerified = loJResp.StringOf("user.verified")
release loHttp
release loJson
release loSbRequestBody
release loSbResponseBody
release loJResp
Curl Command
curl -u login:password -X PUT
-H "Content-Type: application/json"
-H "Accept: application/json"
-d '{
"user": {
"name": "<string>",
"email": "<string>",
"custom_role_id": "<integer>",
"external_id": "<string>",
"identities": [
{
"type": "<string>",
"value": "<string>"
},
{
"type": "<string>",
"value": "<string>"
}
],
"organization": {
"name": "<string>"
},
"organization_id": "<integer>",
"role": "<string>"
}
}'
https://example.zendesk.com/api/v2/users/:user_id/merge
Postman Collection Item JSON
{
"name": "Merge End Users",
"request": {
"method": "PUT",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"user\": {\n \"name\": \"<string>\",\n \"email\": \"<string>\",\n \"custom_role_id\": \"<integer>\",\n \"external_id\": \"<string>\",\n \"identities\": [\n {\n \"type\": \"<string>\",\n \"value\": \"<string>\"\n },\n {\n \"type\": \"<string>\",\n \"value\": \"<string>\"\n }\n ],\n \"organization\": {\n \"name\": \"<string>\"\n },\n \"organization_id\": \"<integer>\",\n \"role\": \"<string>\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/users/:user_id/merge",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"users",
":user_id",
"merge"
],
"variable": [
{
"key": "user_id",
"value": "<integer>"
}
]
},
"description": "Merges the end user specified in the path parameter into the existing end user specified in the request body.\n\nAny two end users can be merged with the exception of end users created by sharing agreements.\n\nAgents and admins cannot be merged.\n\nFor more information about how user data is merged, see [Merging a user's\nduplicate\naccount](https://support.zendesk.com/hc/en-us/articles/4408887695898) in\nZendesk help.\n\n#### Allowed For\n\n* Admins or agents with permission to edit end users\n"
},
"response": [
{
"name": "Success response",
"originalRequest": {
"method": "PUT",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"description": "Added as a part of security scheme: basic",
"key": "Authorization",
"value": "Basic <credentials>"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"user\": {\n \"name\": \"<string>\",\n \"email\": \"<string>\",\n \"custom_role_id\": \"<integer>\",\n \"external_id\": \"<string>\",\n \"identities\": [\n {\n \"type\": \"<string>\",\n \"value\": \"<string>\"\n },\n {\n \"type\": \"<string>\",\n \"value\": \"<string>\"\n }\n ],\n \"organization\": {\n \"name\": \"<string>\"\n },\n \"organization_id\": \"<integer>\",\n \"role\": \"<string>\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/users/:user_id/merge",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"users",
":user_id",
"merge"
],
"variable": [
{
"key": "user_id"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"user\": {\n \"name\": \"<string>\",\n \"active\": \"<boolean>\",\n \"alias\": \"<string>\",\n \"chat_only\": \"<boolean>\",\n \"created_at\": \"<string>\",\n \"custom_role_id\": \"<integer>\",\n \"default_group_id\": \"<integer>\",\n \"details\": \"<string>\",\n \"email\": \"<string>\",\n \"external_id\": \"<string>\",\n \"iana_time_zone\": \"<string>\",\n \"id\": \"<integer>\",\n \"last_login_at\": \"<string>\",\n \"locale\": \"<string>\",\n \"locale_id\": \"<integer>\",\n \"moderator\": \"<boolean>\",\n \"notes\": \"<string>\",\n \"only_private_comments\": \"<boolean>\",\n \"organization_id\": \"<integer>\",\n \"phone\": \"<string>\",\n \"photo\": {\n \"dolorea1\": false,\n \"deserunt3\": 95124319.10825741\n },\n \"remote_photo_url\": \"<string>\",\n \"report_csv\": \"<boolean>\",\n \"restricted_agent\": \"<boolean>\",\n \"role\": \"<string>\",\n \"role_type\": \"<integer>\",\n \"shared\": \"<boolean>\",\n \"shared_agent\": \"<boolean>\",\n \"shared_phone_number\": \"<boolean>\",\n \"signature\": \"<string>\",\n \"suspended\": \"<boolean>\",\n \"tags\": \"<array>\",\n \"ticket_restriction\": \"<string>\",\n \"time_zone\": \"<string>\",\n \"two_factor_auth_enabled\": \"<boolean>\",\n \"updated_at\": \"<string>\",\n \"url\": \"<string>\",\n \"user_fields\": {\n \"nostrudacc\": -12929960.546221554,\n \"in_80e\": 25167751.960886702,\n \"proident_e2\": true,\n \"voluptate_98\": -58995022\n },\n \"verified\": \"<boolean>\"\n }\n}"
}
]
}
