autoit / 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.
$oHttp = ObjCreate("Chilkat.Http")
Local $bSuccess
$oHttp.BasicAuth = True
$oHttp.Login = "login"
$oHttp.Password = "password"
$oHttp.SetRequestHeader "Accept","application/json"
Local $oResp = $oHttp.QuickRequest("PUT","https://example.zendesk.com/api/v2/comment_redactions/:ticket_comment_id")
If ($oHttp.LastMethodSuccess = False) Then
ConsoleWrite($oHttp.LastErrorText & @CRLF)
Exit
EndIf
$oSbResponseBody = ObjCreate("Chilkat.StringBuilder")
$oResp.GetBodySb($oSbResponseBody)
$oJResp = ObjCreate("Chilkat.JsonObject")
$oJResp.LoadSb($oSbResponseBody)
$oJResp.EmitCompact = False
ConsoleWrite("Response Body:" & @CRLF)
ConsoleWrite($oJResp.Emit() & @CRLF)
Local $iRespStatusCode = $oResp.StatusCode
ConsoleWrite("Response Status Code = " & $iRespStatusCode & @CRLF)
If ($iRespStatusCode >= 400) Then
ConsoleWrite("Response Header:" & @CRLF)
ConsoleWrite($oResp.Header & @CRLF)
ConsoleWrite("Failed." & @CRLF)
Exit
EndIf
; 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
Local $sContent_type
Local $sContent_url
Local $sDeleted
Local $sFile_name
Local $sHeight
Local $sId
Local $sInline
Local $sMalware_access_override
Local $sMalware_scan_result
Local $sMapped_content_url
Local $size
Local $sUrl
Local $sWidth
Local $iJ
Local $iCount_j
Local $strVal
Local $sAudit_id = $oJResp.StringOf("comment.audit_id")
Local $sAuthor_id = $oJResp.StringOf("comment.author_id")
Local $sBody = $oJResp.StringOf("comment.body")
Local $sCreated_at = $oJResp.StringOf("comment.created_at")
Local $sHtml_body = $oJResp.StringOf("comment.html_body")
Local $sId = $oJResp.StringOf("comment.id")
Local $sAliquipf9_ = $oJResp.StringOf("comment.metadata.aliquipf9_")
Local $sPlain_body = $oJResp.StringOf("comment.plain_body")
Local $sV_Public = $oJResp.StringOf("comment.public")
Local $sV_Type = $oJResp.StringOf("comment.type")
Local $sChannel = $oJResp.StringOf("comment.via.channel")
Local $iMollit8 = $oJResp.IntOf("comment.via.source.mollit8")
Local $i = 0
Local $iCount_i = $oJResp.SizeOfArray("comment.attachments")
While $i < $iCount_i
$oJResp.I = $i
$sContent_type = $oJResp.StringOf("comment.attachments[i].content_type")
$sContent_url = $oJResp.StringOf("comment.attachments[i].content_url")
$sDeleted = $oJResp.StringOf("comment.attachments[i].deleted")
$sFile_name = $oJResp.StringOf("comment.attachments[i].file_name")
$sHeight = $oJResp.StringOf("comment.attachments[i].height")
$sId = $oJResp.StringOf("comment.attachments[i].id")
$sInline = $oJResp.StringOf("comment.attachments[i].inline")
$sMalware_access_override = $oJResp.StringOf("comment.attachments[i].malware_access_override")
$sMalware_scan_result = $oJResp.StringOf("comment.attachments[i].malware_scan_result")
$sMapped_content_url = $oJResp.StringOf("comment.attachments[i].mapped_content_url")
$size = $oJResp.StringOf("comment.attachments[i].size")
$sUrl = $oJResp.StringOf("comment.attachments[i].url")
$sWidth = $oJResp.StringOf("comment.attachments[i].width")
$iJ = 0
$iCount_j = $oJResp.SizeOfArray("comment.attachments[i].thumbnails")
While $iJ < $iCount_j
$oJResp.J = $iJ
$sContent_type = $oJResp.StringOf("comment.attachments[i].thumbnails[j].content_type")
$sContent_url = $oJResp.StringOf("comment.attachments[i].thumbnails[j].content_url")
$sDeleted = $oJResp.StringOf("comment.attachments[i].thumbnails[j].deleted")
$sFile_name = $oJResp.StringOf("comment.attachments[i].thumbnails[j].file_name")
$sHeight = $oJResp.StringOf("comment.attachments[i].thumbnails[j].height")
$sId = $oJResp.StringOf("comment.attachments[i].thumbnails[j].id")
$sInline = $oJResp.StringOf("comment.attachments[i].thumbnails[j].inline")
$sMalware_access_override = $oJResp.StringOf("comment.attachments[i].thumbnails[j].malware_access_override")
$sMalware_scan_result = $oJResp.StringOf("comment.attachments[i].thumbnails[j].malware_scan_result")
$sMapped_content_url = $oJResp.StringOf("comment.attachments[i].thumbnails[j].mapped_content_url")
$size = $oJResp.StringOf("comment.attachments[i].thumbnails[j].size")
$sUrl = $oJResp.StringOf("comment.attachments[i].thumbnails[j].url")
$sWidth = $oJResp.StringOf("comment.attachments[i].thumbnails[j].width")
$iJ = $iJ + 1
Wend
$i = $i + 1
Wend
$i = 0
$iCount_i = $oJResp.SizeOfArray("comment.uploads")
While $i < $iCount_i
$oJResp.I = $i
$strVal = $oJResp.StringOf("comment.uploads[i]")
$i = $i + 1
Wend
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}"
}
]
}
