delphiAx / Support API / Merge End Users
Back to Collection Items
var
http: TChilkatHttp;
success: Integer;
json: TChilkatJsonObject;
sbRequestBody: TChilkatStringBuilder;
resp: IChilkatHttpResponse;
sbResponseBody: TChilkatStringBuilder;
jResp: TChilkatJsonObject;
respStatusCode: Integer;
Name: WideString;
Active: WideString;
Alias: WideString;
Chat_only: WideString;
Created_at: WideString;
Custom_role_id: WideString;
Default_group_id: WideString;
Details: WideString;
v_Email: WideString;
External_id: WideString;
Iana_time_zone: WideString;
Id: WideString;
Last_login_at: WideString;
Locale: WideString;
Locale_id: WideString;
Moderator: WideString;
Notes: WideString;
Only_private_comments: WideString;
Organization_id: WideString;
Phone: WideString;
Dolorea1: Integer;
Deserunt3: WideString;
Remote_photo_url: WideString;
Report_csv: WideString;
Restricted_agent: WideString;
Role: WideString;
Role_type: WideString;
v_Shared: WideString;
Shared_agent: WideString;
Shared_phone_number: WideString;
Signature: WideString;
Suspended: WideString;
Tags: WideString;
Ticket_restriction: WideString;
Time_zone: WideString;
Two_factor_auth_enabled: WideString;
Updated_at: WideString;
v_Url: WideString;
Nostrudacc: WideString;
In_80e: WideString;
Proident_e2: Integer;
Voluptate_98: Integer;
Verified: WideString;
begin
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
http := TChilkatHttp.Create(Self);
http.BasicAuth := 1;
http.Login := 'login';
http.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>"
// }
// }
json := TChilkatJsonObject.Create(Self);
json.UpdateString('user.name','<string>');
json.UpdateString('user.email','<string>');
json.UpdateString('user.custom_role_id','<integer>');
json.UpdateString('user.external_id','<string>');
json.UpdateString('user.identities[0].type','<string>');
json.UpdateString('user.identities[0].value','<string>');
json.UpdateString('user.identities[1].type','<string>');
json.UpdateString('user.identities[1].value','<string>');
json.UpdateString('user.organization.name','<string>');
json.UpdateString('user.organization_id','<integer>');
json.UpdateString('user.role','<string>');
http.SetRequestHeader('Content-Type','application/json');
http.SetRequestHeader('Accept','application/json');
sbRequestBody := TChilkatStringBuilder.Create(Self);
json.EmitSb(sbRequestBody.ControlInterface);
resp := http.PTextSb('PUT','https://example.zendesk.com/api/v2/users/:user_id/merge',sbRequestBody.ControlInterface,'utf-8','application/json',0,0);
if (http.LastMethodSuccess = 0) then
begin
Memo1.Lines.Add(http.LastErrorText);
Exit;
end;
sbResponseBody := TChilkatStringBuilder.Create(Self);
resp.GetBodySb(sbResponseBody.ControlInterface);
jResp := TChilkatJsonObject.Create(Self);
jResp.LoadSb(sbResponseBody.ControlInterface);
jResp.EmitCompact := 0;
Memo1.Lines.Add('Response Body:');
Memo1.Lines.Add(jResp.Emit());
respStatusCode := resp.StatusCode;
Memo1.Lines.Add('Response Status Code = ' + IntToStr(respStatusCode));
if (respStatusCode >= 400) then
begin
Memo1.Lines.Add('Response Header:');
Memo1.Lines.Add(resp.Header);
Memo1.Lines.Add('Failed.');
Exit;
end;
// 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
Name := jResp.StringOf('user.name');
Active := jResp.StringOf('user.active');
Alias := jResp.StringOf('user.alias');
Chat_only := jResp.StringOf('user.chat_only');
Created_at := jResp.StringOf('user.created_at');
Custom_role_id := jResp.StringOf('user.custom_role_id');
Default_group_id := jResp.StringOf('user.default_group_id');
Details := jResp.StringOf('user.details');
v_Email := jResp.StringOf('user.email');
External_id := jResp.StringOf('user.external_id');
Iana_time_zone := jResp.StringOf('user.iana_time_zone');
Id := jResp.StringOf('user.id');
Last_login_at := jResp.StringOf('user.last_login_at');
Locale := jResp.StringOf('user.locale');
Locale_id := jResp.StringOf('user.locale_id');
Moderator := jResp.StringOf('user.moderator');
Notes := jResp.StringOf('user.notes');
Only_private_comments := jResp.StringOf('user.only_private_comments');
Organization_id := jResp.StringOf('user.organization_id');
Phone := jResp.StringOf('user.phone');
Dolorea1 := jResp.BoolOf('user.photo.dolorea1');
Deserunt3 := jResp.StringOf('user.photo.deserunt3');
Remote_photo_url := jResp.StringOf('user.remote_photo_url');
Report_csv := jResp.StringOf('user.report_csv');
Restricted_agent := jResp.StringOf('user.restricted_agent');
Role := jResp.StringOf('user.role');
Role_type := jResp.StringOf('user.role_type');
v_Shared := jResp.StringOf('user.shared');
Shared_agent := jResp.StringOf('user.shared_agent');
Shared_phone_number := jResp.StringOf('user.shared_phone_number');
Signature := jResp.StringOf('user.signature');
Suspended := jResp.StringOf('user.suspended');
Tags := jResp.StringOf('user.tags');
Ticket_restriction := jResp.StringOf('user.ticket_restriction');
Time_zone := jResp.StringOf('user.time_zone');
Two_factor_auth_enabled := jResp.StringOf('user.two_factor_auth_enabled');
Updated_at := jResp.StringOf('user.updated_at');
v_Url := jResp.StringOf('user.url');
Nostrudacc := jResp.StringOf('user.user_fields.nostrudacc');
In_80e := jResp.StringOf('user.user_fields.in_80e');
Proident_e2 := jResp.BoolOf('user.user_fields.proident_e2');
Voluptate_98 := jResp.IntOf('user.user_fields.voluptate_98');
Verified := jResp.StringOf('user.verified');
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}"
}
]
}
