lianja / Support API / Redact Ticket Comment In Agent Workspace
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"
loHttp.SetRequestHeader("Accept","application/json")
loResp = loHttp.QuickRequest("PUT","https://example.zendesk.com/api/v2/comment_redactions/:ticket_comment_id")
if (loHttp.LastMethodSuccess = .F.) then
? loHttp.LastErrorText
release loHttp
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 loSbResponseBody
release loJResp
return
endif
release loResp
// Sample JSON response:
// (Sample code for parsing the JSON response is shown below)
// {
// "comment": {
// "attachments": [
// {
// "content_type": "<string>",
// "content_url": "<string>",
// "deleted": "<boolean>",
// "file_name": "<string>",
// "height": "<string>",
// "id": "<integer>",
// "inline": "<boolean>",
// "malware_access_override": "<boolean>",
// "malware_scan_result": "<string>",
// "mapped_content_url": "<string>",
// "size": "<integer>",
// "url": "<string>",
// "width": "<string>",
// "thumbnails": [
// {
// "content_type": "<string>",
// "content_url": "<string>",
// "deleted": "<boolean>",
// "file_name": "<string>",
// "height": "<string>",
// "id": "<integer>",
// "inline": "<boolean>",
// "malware_access_override": "<boolean>",
// "malware_scan_result": "<string>",
// "mapped_content_url": "<string>",
// "size": "<integer>",
// "url": "<string>",
// "width": "<string>"
// },
// {
// "content_type": "<string>",
// "content_url": "<string>",
// "deleted": "<boolean>",
// "file_name": "<string>",
// "height": "<string>",
// "id": "<integer>",
// "inline": "<boolean>",
// "malware_access_override": "<boolean>",
// "malware_scan_result": "<string>",
// "mapped_content_url": "<string>",
// "size": "<integer>",
// "url": "<string>",
// "width": "<string>"
// }
// ]
// },
// {
// "content_type": "<string>",
// "content_url": "<string>",
// "deleted": "<boolean>",
// "file_name": "<string>",
// "height": "<string>",
// "id": "<integer>",
// "inline": "<boolean>",
// "malware_access_override": "<boolean>",
// "malware_scan_result": "<string>",
// "mapped_content_url": "<string>",
// "size": "<integer>",
// "url": "<string>",
// "width": "<string>",
// "thumbnails": [
// {
// "content_type": "<string>",
// "content_url": "<string>",
// "deleted": "<boolean>",
// "file_name": "<string>",
// "height": "<string>",
// "id": "<integer>",
// "inline": "<boolean>",
// "malware_access_override": "<boolean>",
// "malware_scan_result": "<string>",
// "mapped_content_url": "<string>",
// "size": "<integer>",
// "url": "<string>",
// "width": "<string>"
// },
// {
// "content_type": "<string>",
// "content_url": "<string>",
// "deleted": "<boolean>",
// "file_name": "<string>",
// "height": "<string>",
// "id": "<integer>",
// "inline": "<boolean>",
// "malware_access_override": "<boolean>",
// "malware_scan_result": "<string>",
// "mapped_content_url": "<string>",
// "size": "<integer>",
// "url": "<string>",
// "width": "<string>"
// }
// ]
// }
// ],
// "audit_id": "<integer>",
// "author_id": "<integer>",
// "body": "<string>",
// "created_at": "<dateTime>",
// "html_body": "<string>",
// "id": "<integer>",
// "metadata": {
// "aliquipf9_": 29396975.17451787
// },
// "plain_body": "<string>",
// "public": "<boolean>",
// "type": "<string>",
// "uploads": [
// "<string>",
// "<string>"
// ],
// "via": {
// "channel": "<string>",
// "source": {
// "mollit8": -84219258
// }
// }
// }
// }
// Sample code for parsing the JSON response...
// Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
lcAudit_id = loJResp.StringOf("comment.audit_id")
lcAuthor_id = loJResp.StringOf("comment.author_id")
lcBody = loJResp.StringOf("comment.body")
lcCreated_at = loJResp.StringOf("comment.created_at")
lcHtml_body = loJResp.StringOf("comment.html_body")
lcId = loJResp.StringOf("comment.id")
lcAliquipf9_ = loJResp.StringOf("comment.metadata.aliquipf9_")
lcPlain_body = loJResp.StringOf("comment.plain_body")
lcV_Public = loJResp.StringOf("comment.public")
lcV_Type = loJResp.StringOf("comment.type")
lcChannel = loJResp.StringOf("comment.via.channel")
lnMollit8 = loJResp.IntOf("comment.via.source.mollit8")
i = 0
lnCount_i = loJResp.SizeOfArray("comment.attachments")
do while i < lnCount_i
loJResp.I = i
lcContent_type = loJResp.StringOf("comment.attachments[i].content_type")
lcContent_url = loJResp.StringOf("comment.attachments[i].content_url")
lcDeleted = loJResp.StringOf("comment.attachments[i].deleted")
lcFile_name = loJResp.StringOf("comment.attachments[i].file_name")
lcHeight = loJResp.StringOf("comment.attachments[i].height")
lcId = loJResp.StringOf("comment.attachments[i].id")
lcInline = loJResp.StringOf("comment.attachments[i].inline")
lcMalware_access_override = loJResp.StringOf("comment.attachments[i].malware_access_override")
lcMalware_scan_result = loJResp.StringOf("comment.attachments[i].malware_scan_result")
lcMapped_content_url = loJResp.StringOf("comment.attachments[i].mapped_content_url")
lcSize = loJResp.StringOf("comment.attachments[i].size")
lcUrl = loJResp.StringOf("comment.attachments[i].url")
lcWidth = loJResp.StringOf("comment.attachments[i].width")
j = 0
lnCount_j = loJResp.SizeOfArray("comment.attachments[i].thumbnails")
do while j < lnCount_j
loJResp.J = j
lcContent_type = loJResp.StringOf("comment.attachments[i].thumbnails[j].content_type")
lcContent_url = loJResp.StringOf("comment.attachments[i].thumbnails[j].content_url")
lcDeleted = loJResp.StringOf("comment.attachments[i].thumbnails[j].deleted")
lcFile_name = loJResp.StringOf("comment.attachments[i].thumbnails[j].file_name")
lcHeight = loJResp.StringOf("comment.attachments[i].thumbnails[j].height")
lcId = loJResp.StringOf("comment.attachments[i].thumbnails[j].id")
lcInline = loJResp.StringOf("comment.attachments[i].thumbnails[j].inline")
lcMalware_access_override = loJResp.StringOf("comment.attachments[i].thumbnails[j].malware_access_override")
lcMalware_scan_result = loJResp.StringOf("comment.attachments[i].thumbnails[j].malware_scan_result")
lcMapped_content_url = loJResp.StringOf("comment.attachments[i].thumbnails[j].mapped_content_url")
lcSize = loJResp.StringOf("comment.attachments[i].thumbnails[j].size")
lcUrl = loJResp.StringOf("comment.attachments[i].thumbnails[j].url")
lcWidth = loJResp.StringOf("comment.attachments[i].thumbnails[j].width")
j = j + 1
enddo
i = i + 1
enddo
i = 0
lnCount_i = loJResp.SizeOfArray("comment.uploads")
do while i < lnCount_i
loJResp.I = i
lcStrVal = loJResp.StringOf("comment.uploads[i]")
i = i + 1
enddo
release loHttp
release loSbResponseBody
release loJResp
Curl Command
curl -u login:password -X PUT
-H "Accept: application/json"
https://example.zendesk.com/api/v2/comment_redactions/:ticket_comment_id
Postman Collection Item JSON
{
"name": "Redact Ticket Comment In Agent Workspace",
"request": {
"method": "PUT",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/comment_redactions/:ticket_comment_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"comment_redactions",
":ticket_comment_id"
],
"variable": [
{
"key": "ticket_comment_id",
"value": "<integer>"
}
]
},
"description": "Redaction allows you to permanently remove words, strings, or attachments from a ticket comment.\n\nIn the `html_body` of the comment, wrap the content you want redacted in `<redact>` tags. Example:\n\n```json\n{\n \"html_body\": \"<div class=\\\"zd-comment\\\" dir=\\\"auto\\\">My ID number is <redact>847564</redact>!</div>\",\n \"ticket_id\":100\n}\n```\n\nThe characters in the redact tag will be replaced by the ▇ symbol.\n\nTo redact inline images and anchor tags, add the individual attribute `redact` to the element. Example: `<a href=\"http://example.com\" redact>some link</a>`.\n\nRedaction is permanent and can not be undone. Data is permanently deleted from Zendesk servers with no way to recover it.\n\nThis endpoint provides all the same functionality that the [Redact String in Comment](/api-reference/ticketing/tickets/ticket_comments/#redact-string-in-comment) endpoint provides, plus:\n\n- Redaction of comments in closed tickets\n\n- Redaction of comments in archived tickets\n\n- Redaction of formatted text (bold, italics, hyperlinks)\n\n**Limitations**: When content is redacted from an email comment, the content is also redacted from the original email through a background job. It may take a while for the changes to be completed.\n\n**Note**: We recommend using this endpoint instead of the [Redact String in Comment](/api-reference/ticketing/tickets/ticket_comments/#redact-string-in-comment) endpoint, which will eventually be deprecated.\n\n#### Allowed For\n\n- Agents\n\n[Agent Workspace](https://support.zendesk.com/hc/en-us/articles/360024218473) must be enabled on the account. For professional accounts, deleting tickets must be enabled for agents. On Enterprise accounts, you can assign agents to a custom role with permissions to redact ticket content.\n\n#### Request Body Properties\n\n| Name | Type | Required | Description |\n| -------------------------| ------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------ |\n| ticket_id | integer | true | The ID of the ticket |\n| html_body | string | false | The `html_body` of the comment containing `<redact>` tags or `redact` attributes |\n| external_attachment_urls | array | false | Array of attachment URLs belonging to the comment to be redacted. See [`content_url` property of Attachment](/api-reference/ticketing/tickets/ticket-attachments/) |\n"
},
"response": [
{
"name": "Success response",
"originalRequest": {
"method": "PUT",
"header": [
{
"description": "Added as a part of security scheme: basic",
"key": "Authorization",
"value": "Basic <credentials>"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/comment_redactions/:ticket_comment_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"comment_redactions",
":ticket_comment_id"
],
"variable": [
{
"key": "ticket_comment_id"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"comment\": {\n \"attachments\": [\n {\n \"content_type\": \"<string>\",\n \"content_url\": \"<string>\",\n \"deleted\": \"<boolean>\",\n \"file_name\": \"<string>\",\n \"height\": \"<string>\",\n \"id\": \"<integer>\",\n \"inline\": \"<boolean>\",\n \"malware_access_override\": \"<boolean>\",\n \"malware_scan_result\": \"<string>\",\n \"mapped_content_url\": \"<string>\",\n \"size\": \"<integer>\",\n \"url\": \"<string>\",\n \"width\": \"<string>\",\n \"thumbnails\": [\n {\n \"content_type\": \"<string>\",\n \"content_url\": \"<string>\",\n \"deleted\": \"<boolean>\",\n \"file_name\": \"<string>\",\n \"height\": \"<string>\",\n \"id\": \"<integer>\",\n \"inline\": \"<boolean>\",\n \"malware_access_override\": \"<boolean>\",\n \"malware_scan_result\": \"<string>\",\n \"mapped_content_url\": \"<string>\",\n \"size\": \"<integer>\",\n \"url\": \"<string>\",\n \"width\": \"<string>\"\n },\n {\n \"content_type\": \"<string>\",\n \"content_url\": \"<string>\",\n \"deleted\": \"<boolean>\",\n \"file_name\": \"<string>\",\n \"height\": \"<string>\",\n \"id\": \"<integer>\",\n \"inline\": \"<boolean>\",\n \"malware_access_override\": \"<boolean>\",\n \"malware_scan_result\": \"<string>\",\n \"mapped_content_url\": \"<string>\",\n \"size\": \"<integer>\",\n \"url\": \"<string>\",\n \"width\": \"<string>\"\n }\n ]\n },\n {\n \"content_type\": \"<string>\",\n \"content_url\": \"<string>\",\n \"deleted\": \"<boolean>\",\n \"file_name\": \"<string>\",\n \"height\": \"<string>\",\n \"id\": \"<integer>\",\n \"inline\": \"<boolean>\",\n \"malware_access_override\": \"<boolean>\",\n \"malware_scan_result\": \"<string>\",\n \"mapped_content_url\": \"<string>\",\n \"size\": \"<integer>\",\n \"url\": \"<string>\",\n \"width\": \"<string>\",\n \"thumbnails\": [\n {\n \"content_type\": \"<string>\",\n \"content_url\": \"<string>\",\n \"deleted\": \"<boolean>\",\n \"file_name\": \"<string>\",\n \"height\": \"<string>\",\n \"id\": \"<integer>\",\n \"inline\": \"<boolean>\",\n \"malware_access_override\": \"<boolean>\",\n \"malware_scan_result\": \"<string>\",\n \"mapped_content_url\": \"<string>\",\n \"size\": \"<integer>\",\n \"url\": \"<string>\",\n \"width\": \"<string>\"\n },\n {\n \"content_type\": \"<string>\",\n \"content_url\": \"<string>\",\n \"deleted\": \"<boolean>\",\n \"file_name\": \"<string>\",\n \"height\": \"<string>\",\n \"id\": \"<integer>\",\n \"inline\": \"<boolean>\",\n \"malware_access_override\": \"<boolean>\",\n \"malware_scan_result\": \"<string>\",\n \"mapped_content_url\": \"<string>\",\n \"size\": \"<integer>\",\n \"url\": \"<string>\",\n \"width\": \"<string>\"\n }\n ]\n }\n ],\n \"audit_id\": \"<integer>\",\n \"author_id\": \"<integer>\",\n \"body\": \"<string>\",\n \"created_at\": \"<dateTime>\",\n \"html_body\": \"<string>\",\n \"id\": \"<integer>\",\n \"metadata\": {\n \"aliquipf9_\": 29396975.17451787\n },\n \"plain_body\": \"<string>\",\n \"public\": \"<boolean>\",\n \"type\": \"<string>\",\n \"uploads\": [\n \"<string>\",\n \"<string>\"\n ],\n \"via\": {\n \"channel\": \"<string>\",\n \"source\": {\n \"mollit8\": -84219258\n }\n }\n }\n}"
}
]
}
