delphiDll / Support API / Merge Tickets into Target Ticket
Back to Collection Items
var
http: HCkHttp;
success: Boolean;
json: HCkJsonObject;
resp: HCkHttpResponse;
sbResponseBody: HCkStringBuilder;
jResp: HCkJsonObject;
respStatusCode: Integer;
id: PWideChar;
index: PWideChar;
Id: PWideChar;
Message: PWideChar;
Progress: PWideChar;
Status: PWideChar;
Total: PWideChar;
v_Url: PWideChar;
i: Integer;
count_i: Integer;
begin
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
http := CkHttp_Create();
CkHttp_putBasicAuth(http,True);
CkHttp_putLogin(http,'login');
CkHttp_putPassword(http,'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.
// {
// "ids": "<array>",
// "source_comment": "<string>",
// "source_comment_is_public": "<boolean>",
// "target_comment": "<string>",
// "target_comment_is_public": "<boolean>"
// }
json := CkJsonObject_Create();
CkJsonObject_UpdateString(json,'ids','<array>');
CkJsonObject_UpdateString(json,'source_comment','<string>');
CkJsonObject_UpdateString(json,'source_comment_is_public','<boolean>');
CkJsonObject_UpdateString(json,'target_comment','<string>');
CkJsonObject_UpdateString(json,'target_comment_is_public','<boolean>');
CkHttp_SetRequestHeader(http,'Content-Type','application/json');
CkHttp_SetRequestHeader(http,'Accept','application/json');
resp := CkHttp_PostJson3(http,'https://example.zendesk.com/api/v2/tickets/:ticket_id/merge','application/json',json);
if (CkHttp_getLastMethodSuccess(http) = False) then
begin
Memo1.Lines.Add(CkHttp__lastErrorText(http));
Exit;
end;
sbResponseBody := CkStringBuilder_Create();
CkHttpResponse_GetBodySb(resp,sbResponseBody);
jResp := CkJsonObject_Create();
CkJsonObject_LoadSb(jResp,sbResponseBody);
CkJsonObject_putEmitCompact(jResp,False);
Memo1.Lines.Add('Response Body:');
Memo1.Lines.Add(CkJsonObject__emit(jResp));
respStatusCode := CkHttpResponse_getStatusCode(resp);
Memo1.Lines.Add('Response Status Code = ' + IntToStr(respStatusCode));
if (respStatusCode >= 400) then
begin
Memo1.Lines.Add('Response Header:');
Memo1.Lines.Add(CkHttpResponse__header(resp));
Memo1.Lines.Add('Failed.');
CkHttpResponse_Dispose(resp);
Exit;
end;
CkHttpResponse_Dispose(resp);
// Sample JSON response:
// (Sample code for parsing the JSON response is shown below)
// {
// "job_status": {
// "id": "<string>",
// "message": "<string>",
// "progress": "<integer>",
// "results": [
// {
// "id": "<integer>",
// "index": "<integer>"
// },
// {
// "id": "<integer>",
// "index": "<integer>"
// }
// ],
// "status": "<string>",
// "total": "<integer>",
// "url": "<string>"
// }
// }
// Sample code for parsing the JSON response...
// Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
Id := CkJsonObject__stringOf(jResp,'job_status.id');
Message := CkJsonObject__stringOf(jResp,'job_status.message');
Progress := CkJsonObject__stringOf(jResp,'job_status.progress');
Status := CkJsonObject__stringOf(jResp,'job_status.status');
Total := CkJsonObject__stringOf(jResp,'job_status.total');
v_Url := CkJsonObject__stringOf(jResp,'job_status.url');
i := 0;
count_i := CkJsonObject_SizeOfArray(jResp,'job_status.results');
while i < count_i do
begin
CkJsonObject_putI(jResp,i);
id := CkJsonObject__stringOf(jResp,'job_status.results[i].id');
index := CkJsonObject__stringOf(jResp,'job_status.results[i].index');
i := i + 1;
end;
CkHttp_Dispose(http);
CkJsonObject_Dispose(json);
CkStringBuilder_Dispose(sbResponseBody);
CkJsonObject_Dispose(jResp);
Curl Command
curl -u login:password -X POST
-H "Content-Type: application/json"
-H "Accept: application/json"
-d '{
"ids": "<array>",
"source_comment": "<string>",
"source_comment_is_public": "<boolean>",
"target_comment": "<string>",
"target_comment_is_public": "<boolean>"
}'
https://example.zendesk.com/api/v2/tickets/:ticket_id/merge
Postman Collection Item JSON
{
"name": "Merge Tickets into Target Ticket",
"request": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"ids\": \"<array>\",\n \"source_comment\": \"<string>\",\n \"source_comment_is_public\": \"<boolean>\",\n \"target_comment\": \"<string>\",\n \"target_comment_is_public\": \"<boolean>\"\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/tickets/:ticket_id/merge",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"tickets",
":ticket_id",
"merge"
],
"variable": [
{
"key": "ticket_id",
"value": "<integer>"
}
]
},
"description": "Merges one or more tickets into the ticket with the specified id.\n\nSee [Merging tickets](https://support.zendesk.com/hc/en-us/articles/203690916)\nin the Support Help Center for ticket merging rules.\n\nAny attachment to the source ticket is copied to the target ticket.\n\nThis endpoint returns a `job_status` [JSON object](/api-reference/ticketing/ticket-management/job_statuses/#json-format) and queues a background job to do the work.\nUse the [Show Job Status](/api-reference/ticketing/ticket-management/job_statuses/#show-job-status) endpoint to check for the job's completion.\n\n#### Allowed For\n\n* Agents\n\nAgents in the Enterprise account must have merge permissions.\nSee [Creating custom roles and assigning agents (Enterprise)](https://support.zendesk.com/hc/en-us/articles/203662026)\nin the Support Help Center.\n\n#### Available parameters\n\nThe request takes a data object with the following properties:\n\n| Name | Type | Required | Comments |\n| ------------------------ | ------- | -------- | ------------------------------------------------------- |\n| ids | array | yes | Ids of tickets to merge into the target ticket |\n| target_comment | string | no | Private comment to add to the target ticket |\n| source_comment | string | no | Private comment to add to the source ticket |\n| target_comment_is_public | boolean | no | Whether comment in target ticket is public or private |\n| source_comment_is_public | boolean | no | Whether comment in source tickets are public or private |\n\nThe comments are optional but strongly recommended.\n\nComments are private and can't be modified in the following cases:\n\n * Any of the sources or target tickets are private\n * Any of the sources or target tickets were created through Twitter, Facebook or the Channel framework\n\nIn any other case, comments default to private but can be modified with the comment privacy parameters."
},
"response": [
{
"name": "Successful response",
"originalRequest": {
"method": "POST",
"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 \"ids\": \"<array>\",\n \"source_comment\": \"<string>\",\n \"source_comment_is_public\": \"<boolean>\",\n \"target_comment\": \"<string>\",\n \"target_comment_is_public\": \"<boolean>\"\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/tickets/:ticket_id/merge",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"tickets",
":ticket_id",
"merge"
],
"variable": [
{
"key": "ticket_id"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"job_status\": {\n \"id\": \"<string>\",\n \"message\": \"<string>\",\n \"progress\": \"<integer>\",\n \"results\": [\n {\n \"id\": \"<integer>\",\n \"index\": \"<integer>\"\n },\n {\n \"id\": \"<integer>\",\n \"index\": \"<integer>\"\n }\n ],\n \"status\": \"<string>\",\n \"total\": \"<integer>\",\n \"url\": \"<string>\"\n }\n}"
}
]
}
