Chilkat Online Tools

Delphi (DLL) / Support API / Redact Comment Attachment

Back to Collection Items

var

begin
CkHttp_putBasicAuth(http,True);CkHttp_putLogin(http,'login');CkHttp_putPassword(http,'password');CkHttpResponse_GetBodySb(resp,sbResponseBody);CkJsonObject_LoadSb(jResp,sbResponseBody);CkJsonObject_putEmitCompact(jResp,False);CkJsonObject_putI(jResp,i);content_type := CkJsonObject__stringOf(jResp,'attachment.thumbnails[i].content_type');content_url := CkJsonObject__stringOf(jResp,'attachment.thumbnails[i].content_url');deleted := CkJsonObject__stringOf(jResp,'attachment.thumbnails[i].deleted');file_name := CkJsonObject__stringOf(jResp,'attachment.thumbnails[i].file_name');height := CkJsonObject__stringOf(jResp,'attachment.thumbnails[i].height');id := CkJsonObject__stringOf(jResp,'attachment.thumbnails[i].id');inline := CkJsonObject__stringOf(jResp,'attachment.thumbnails[i].inline');malware_access_override := CkJsonObject__stringOf(jResp,'attachment.thumbnails[i].malware_access_override');malware_scan_result := CkJsonObject__stringOf(jResp,'attachment.thumbnails[i].malware_scan_result');mapped_content_url := CkJsonObject__stringOf(jResp,'attachment.thumbnails[i].mapped_content_url');size := CkJsonObject__stringOf(jResp,'attachment.thumbnails[i].size');url := CkJsonObject__stringOf(jResp,'attachment.thumbnails[i].url');width := CkJsonObject__stringOf(jResp,'attachment.thumbnails[i].width');i := i + 1;

Curl Command

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

Postman Collection Item JSON

{
  "name": "Redact Comment Attachment",
  "request": {
    "method": "PUT",
    "header": [
      {
        "key": "Accept",
        "value": "application/json"
      }
    ],
    "url": {
      "raw": "{{baseUrl}}/api/v2/tickets/:ticket_id/comments/:comment_id/attachments/:attachment_id/redact",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "api",
        "v2",
        "tickets",
        ":ticket_id",
        "comments",
        ":comment_id",
        "attachments",
        ":attachment_id",
        "redact"
      ],
      "variable": [
        {
          "key": "ticket_id",
          "value": "<integer>"
        },
        {
          "key": "comment_id",
          "value": "<integer>"
        },
        {
          "key": "attachment_id",
          "value": "<integer>"
        }
      ]
    },
    "description": "Redaction allows you to permanently remove attachments from an existing comment on a ticket. Once removed from a comment, the attachment is replaced with an empty \"redacted.txt\" file.\n\nThe redaction is permanent. It is not possible to undo redaction or see what was removed. Once a ticket is closed, redacting its attachments is no longer possible.\n\nAlso, if you want to redact an inline attachment, you can use the `include_inline_images` parameter in the [List Comments](/api-reference/ticketing/tickets/ticket_comments/#list-comments) operation to obtain the inline attachment ID, and use it in the request URL.\n\n#### Allowed For\n\n* Admins\n* Agents when [deleting tickets is enabled for agents on professional accounts](https://support.zendesk.com/hc/en-us/articles/360002128107)\n* Agents assigned to a custom role with permissions to redact ticket content (Enterprise only)\n"
  },
  "response": [
    {
      "name": "OK 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/:comment_id/attachments/:attachment_id/redact",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v2",
            "tickets",
            ":ticket_id",
            "comments",
            ":comment_id",
            "attachments",
            ":attachment_id",
            "redact"
          ],
          "variable": [
            {
              "key": "ticket_id"
            },
            {
              "key": "comment_id"
            },
            {
              "key": "attachment_id"
            }
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n  \"attachment\": {\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}"
    }
  ]
}