Chilkat Online Tools

Node.js / Support API / Redact String in Comment

Back to Collection Items

var os = require('os');
if (os.platform() == 'win32') {  
    if (os.arch() == 'ia32') {
        var chilkat = require('@chilkat/ck-node21-win-ia32');
    } else {
        var chilkat = require('@chilkat/ck-node21-win64'); 
    }
} else if (os.platform() == 'linux') {
    if (os.arch() == 'arm') {
        var chilkat = require('@chilkat/ck-node21-arm');
    } else if (os.arch() == 'x86') {
        var chilkat = require('@chilkat/ck-node21-linux32');
    } else {
        var chilkat = require('@chilkat/ck-node21-linux64');
    }
} else if (os.platform() == 'darwin') {
    if (os.arch() == 'arm64') {
        var chilkat = require('@chilkat/ck-node21-mac-m1');
    } else {
        var chilkat = require('@chilkat/ck-node21-macosx');
    }
}


function chilkatExample() {

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

    var http = new chilkat.Http();
    var success;

    http.BasicAuth = true;
    http.Login = "login";
    http.Password = "password";

    http.SetRequestHeader("Accept","application/json");

    // resp: HttpResponse
    var resp = http.QuickRequest("PUT","https://example.zendesk.com/api/v2/tickets/:ticket_id/comments/:ticket_comment_id/redact");
    if (http.LastMethodSuccess == false) {
        console.log(http.LastErrorText);
        return;
    }

    var sbResponseBody = new chilkat.StringBuilder();
    resp.GetBodySb(sbResponseBody);

    var jResp = new chilkat.JsonObject();
    jResp.LoadSb(sbResponseBody);
    jResp.EmitCompact = false;

    console.log("Response Body:");
    console.log(jResp.Emit());

    var respStatusCode = resp.StatusCode;
    console.log("Response Status Code = " + respStatusCode);
    if (respStatusCode >= 400) {
        console.log("Response Header:");
        console.log(resp.Header);
        console.log("Failed.");

        return;
    }

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

    var content_type;
    var content_url;
    var deleted;
    var file_name;
    var height;
    var id;
    var inline;
    var malware_access_override;
    var malware_scan_result;
    var mapped_content_url;
    var size;
    var url;
    var width;
    var j;
    var count_j;
    var strVal;

    var Audit_id = jResp.StringOf("comment.audit_id");
    var Author_id = jResp.StringOf("comment.author_id");
    var Body = jResp.StringOf("comment.body");
    var Created_at = jResp.StringOf("comment.created_at");
    var Html_body = jResp.StringOf("comment.html_body");
    var Id = jResp.StringOf("comment.id");
    var Aliquipf9_ = jResp.StringOf("comment.metadata.aliquipf9_");
    var Plain_body = jResp.StringOf("comment.plain_body");
    var v_Public = jResp.StringOf("comment.public");
    var v_Type = jResp.StringOf("comment.type");
    var Channel = jResp.StringOf("comment.via.channel");
    var Mollit8 = jResp.IntOf("comment.via.source.mollit8");
    var i = 0;
    var 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;
    }


}

chilkatExample();

Curl Command

curl  -u login:password -X PUT
	-H "Accept: application/json"
https://example.zendesk.com/api/v2/tickets/:ticket_id/comments/:ticket_comment_id/redact

Postman Collection Item JSON

{
  "name": "Redact String in Comment",
  "request": {
    "method": "PUT",
    "header": [
      {
        "key": "Accept",
        "value": "application/json"
      }
    ],
    "url": {
      "raw": "{{baseUrl}}/api/v2/tickets/:ticket_id/comments/:ticket_comment_id/redact",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "api",
        "v2",
        "tickets",
        ":ticket_id",
        "comments",
        ":ticket_comment_id",
        "redact"
      ],
      "variable": [
        {
          "key": "ticket_id",
          "value": "<integer>"
        },
        {
          "key": "ticket_comment_id",
          "value": "<integer>"
        }
      ]
    },
    "description": "Permanently removes words or strings from a ticket comment. Specify the string to redact in an object with a `text` property. Example: `'{\"text\": \"987-65-4320\"}'`. The characters of the word or string are replaced by the ▇ symbol.\n\nIf the comment was made by email, the endpoint also attempts to redact the string from the original email retained by Zendesk for audit purposes.\n\n**Note**: If you use the rich text editor, support for redacting formatted text (bold, italics, hyperlinks) is limited.\n\nRedaction is permanent. You can't undo the redaction or see *what* was removed. Once a ticket is closed, you can no longer redact strings from its comments.\n\nTo use this endpoint, the \"Agents can delete tickets\" option must be enabled in the Zendesk Support admin interface at **Admin** > **Settings** > **Agents**.\n\n#### Allowed For\n\n* Agents\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/tickets/:ticket_id/comments/:ticket_comment_id/redact",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v2",
            "tickets",
            ":ticket_id",
            "comments",
            ":ticket_comment_id",
            "redact"
          ],
          "variable": [
            {
              "key": "ticket_id"
            },
            {
              "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}"
    }
  ]
}