PowerBuilder / Support API / Merge Tickets into Target Ticket
Back to Collection Items
integer li_rc
oleobject loo_Http
integer li_Success
oleobject loo_Json
oleobject loo_Resp
oleobject loo_SbResponseBody
oleobject loo_JResp
integer li_RespStatusCode
string ls_Id
string ls_Index
string ls_Id
string ls_Message
string ls_Progress
string ls_Status
string ls_Total
string ls_V_Url
integer i
integer li_Count_i
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
loo_Http = create oleobject
// Use "Chilkat_9_5_0.Http" for versions of Chilkat < 10.0.0
li_rc = loo_Http.ConnectToNewObject("Chilkat.Http")
if li_rc < 0 then
destroy loo_Http
MessageBox("Error","Connecting to COM object failed")
return
end if
loo_Http.BasicAuth = 1
loo_Http.Login = "login"
loo_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.
// {
// "ids": "<array>",
// "source_comment": "<string>",
// "source_comment_is_public": "<boolean>",
// "target_comment": "<string>",
// "target_comment_is_public": "<boolean>"
// }
loo_Json = create oleobject
// Use "Chilkat_9_5_0.JsonObject" for versions of Chilkat < 10.0.0
li_rc = loo_Json.ConnectToNewObject("Chilkat.JsonObject")
loo_Json.UpdateString("ids","<array>")
loo_Json.UpdateString("source_comment","<string>")
loo_Json.UpdateString("source_comment_is_public","<boolean>")
loo_Json.UpdateString("target_comment","<string>")
loo_Json.UpdateString("target_comment_is_public","<boolean>")
loo_Http.SetRequestHeader("Content-Type","application/json")
loo_Http.SetRequestHeader("Accept","application/json")
loo_Resp = loo_Http.PostJson3("https://example.zendesk.com/api/v2/tickets/:ticket_id/merge","application/json",loo_Json)
if loo_Http.LastMethodSuccess = 0 then
Write-Debug loo_Http.LastErrorText
destroy loo_Http
destroy loo_Json
return
end if
loo_SbResponseBody = create oleobject
// Use "Chilkat_9_5_0.StringBuilder" for versions of Chilkat < 10.0.0
li_rc = loo_SbResponseBody.ConnectToNewObject("Chilkat.StringBuilder")
loo_Resp.GetBodySb(loo_SbResponseBody)
loo_JResp = create oleobject
// Use "Chilkat_9_5_0.JsonObject" for versions of Chilkat < 10.0.0
li_rc = loo_JResp.ConnectToNewObject("Chilkat.JsonObject")
loo_JResp.LoadSb(loo_SbResponseBody)
loo_JResp.EmitCompact = 0
Write-Debug "Response Body:"
Write-Debug loo_JResp.Emit()
li_RespStatusCode = loo_Resp.StatusCode
Write-Debug "Response Status Code = " + string(li_RespStatusCode)
if li_RespStatusCode >= 400 then
Write-Debug "Response Header:"
Write-Debug loo_Resp.Header
Write-Debug "Failed."
destroy loo_Resp
destroy loo_Http
destroy loo_Json
destroy loo_SbResponseBody
destroy loo_JResp
return
end if
destroy loo_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
ls_Id = loo_JResp.StringOf("job_status.id")
ls_Message = loo_JResp.StringOf("job_status.message")
ls_Progress = loo_JResp.StringOf("job_status.progress")
ls_Status = loo_JResp.StringOf("job_status.status")
ls_Total = loo_JResp.StringOf("job_status.total")
ls_V_Url = loo_JResp.StringOf("job_status.url")
i = 0
li_Count_i = loo_JResp.SizeOfArray("job_status.results")
do while i < li_Count_i
loo_JResp.I = i
ls_Id = loo_JResp.StringOf("job_status.results[i].id")
ls_Index = loo_JResp.StringOf("job_status.results[i].index")
i = i + 1
loop
destroy loo_Http
destroy loo_Json
destroy loo_SbResponseBody
destroy loo_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}"
}
]
}
