Chilkat Tools

phpAx / Support API / Redact Ticket Comment In Agent Workspace

<?php

// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.

$http = new COM("Chilkat_9_5_0.Http");

$http->BasicAuth = 1;
$http->Login = 'login';
$http->Password = 'password';

$http->SetRequestHeader('Accept','application/json');

// resp is a Chilkat_9_5_0.HttpResponse
$resp = $http->QuickRequest('PUT','https://example.zendesk.com/api/v2/comment_redactions/:ticket_comment_id');
if ($http->LastMethodSuccess == 0) {
    print $http->LastErrorText . "\n";
    exit;
}

$sbResponseBody = new COM("Chilkat_9_5_0.StringBuilder");
$resp->GetBodySb($sbResponseBody);

$jResp = new COM("Chilkat_9_5_0.JsonObject");
$jResp->LoadSb($sbResponseBody);
$jResp->EmitCompact = 0;

print 'Response Body:' . "\n";
print $jResp->emit() . "\n";

$respStatusCode = $resp->StatusCode;
print 'Response Status Code = ' . $respStatusCode . "\n";
if ($respStatusCode >= 400) {
    print 'Response Header:' . "\n";
    print $resp->Header . "\n";
    print 'Failed.' . "\n";

    exit;
}

// 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

$Audit_id = $jResp->stringOf('comment.audit_id');
$Author_id = $jResp->stringOf('comment.author_id');
$Body = $jResp->stringOf('comment.body');
$Created_at = $jResp->stringOf('comment.created_at');
$Html_body = $jResp->stringOf('comment.html_body');
$Id = $jResp->stringOf('comment.id');
$Aliquipf9_ = $jResp->stringOf('comment.metadata.aliquipf9_');
$Plain_body = $jResp->stringOf('comment.plain_body');
$v_Public = $jResp->stringOf('comment.public');
$v_Type = $jResp->stringOf('comment.type');
$Channel = $jResp->stringOf('comment.via.channel');
$Mollit8 = $jResp->IntOf('comment.via.source.mollit8');
$i = 0;
$count_i = $jResp->SizeOfArray('comment.attachments');
while ($i < $count_i) {
    $jResp->I = $i;
    $content_type = $jResp->stringOf('comment.attachments[i].content_type');
    $content_url = $jResp->stringOf('comment.attachments[i].content_url');
    $deleted = $jResp->stringOf('comment.attachments[i].deleted');
    $file_name = $jResp->stringOf('comment.attachments[i].file_name');
    $height = $jResp->stringOf('comment.attachments[i].height');
    $id = $jResp->stringOf('comment.attachments[i].id');
    $inline = $jResp->stringOf('comment.attachments[i].inline');
    $malware_access_override = $jResp->stringOf('comment.attachments[i].malware_access_override');
    $malware_scan_result = $jResp->stringOf('comment.attachments[i].malware_scan_result');
    $mapped_content_url = $jResp->stringOf('comment.attachments[i].mapped_content_url');
    $size = $jResp->stringOf('comment.attachments[i].size');
    $url = $jResp->stringOf('comment.attachments[i].url');
    $width = $jResp->stringOf('comment.attachments[i].width');
    $j = 0;
    $count_j = $jResp->SizeOfArray('comment.attachments[i].thumbnails');
    while ($j < $count_j) {
        $jResp->J = $j;
        $content_type = $jResp->stringOf('comment.attachments[i].thumbnails[j].content_type');
        $content_url = $jResp->stringOf('comment.attachments[i].thumbnails[j].content_url');
        $deleted = $jResp->stringOf('comment.attachments[i].thumbnails[j].deleted');
        $file_name = $jResp->stringOf('comment.attachments[i].thumbnails[j].file_name');
        $height = $jResp->stringOf('comment.attachments[i].thumbnails[j].height');
        $id = $jResp->stringOf('comment.attachments[i].thumbnails[j].id');
        $inline = $jResp->stringOf('comment.attachments[i].thumbnails[j].inline');
        $malware_access_override = $jResp->stringOf('comment.attachments[i].thumbnails[j].malware_access_override');
        $malware_scan_result = $jResp->stringOf('comment.attachments[i].thumbnails[j].malware_scan_result');
        $mapped_content_url = $jResp->stringOf('comment.attachments[i].thumbnails[j].mapped_content_url');
        $size = $jResp->stringOf('comment.attachments[i].thumbnails[j].size');
        $url = $jResp->stringOf('comment.attachments[i].thumbnails[j].url');
        $width = $jResp->stringOf('comment.attachments[i].thumbnails[j].width');
        $j = $j + 1;
    }

    $i = $i + 1;
}

$i = 0;
$count_i = $jResp->SizeOfArray('comment.uploads');
while ($i < $count_i) {
    $jResp->I = $i;
    $strVal = $jResp->stringOf('comment.uploads[i]');
    $i = $i + 1;
}


?>

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}"
    }
  ]
}

Chilkat Online Tools

phpAx / Support API / Redact Ticket Comment In Agent Workspace

Curl Command

Postman Collection Item JSON