{
  "opencollection": "1.0.0",
  "info": {
    "name": "Zendesk Account Account Settings Ticket Comments API",
    "version": "1.0"
  },
  "items": [
    {
      "info": {
        "name": "Ticket Comments",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Zendesk Put  Api V2 Chat_file_redactions Ticket_id",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "{{baseUrl}}/api/v2/chat_file_redactions/:ticket_id"
          },
          "docs": "Permanently removes one or more chat attachments from a chat ticket.\n\n**Note**: This does not work on active chats. For chat tickets that predate March 2020, consider using [Redact Ticket Comment In Agent Workspace](#redact-ticket-comment-in-agent-workspace).\n\n#### Allowed For\n\n- Agents\n\n[Agent Workspace](https://support.zendesk.com/hc/en-us/articles/360024218473) must enabled for the account. Deleting tickets must be enabled for agents.\n\n#### Request Body Properties\n\n| Name         | Type    | "
        },
        {
          "info": {
            "name": "Zendesk Put  Api V2 Chat_redactions Ticket_id",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "{{baseUrl}}/api/v2/chat_redactions/:ticket_id"
          },
          "docs": "Permanently removes words or strings from a chat ticket's comment. \n\nWrap `<redact>` tags around the content in the chat comment you want redacted. Example: \n\n```json\n{\n  \"text\": \"My ID number is <redact>847564</redact>!\"\n}\n```\n\nThe characters contained in the tag will be replaced by the ▇ symbol.\n\n**Note**: This does not work on active chats. For chat tickets that predate March 2020, consider using [Redact Ticket Comment In Agent Workspace](#redact-ticket-comment-in-agent-workspace).\n\n#### Allo"
        },
        {
          "info": {
            "name": "Zendesk Put  Api V2 Comment_redactions Ticket_comment_id",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "{{baseUrl}}/api/v2/comment_redactions/:ticket_comment_id"
          },
          "docs": "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 HTML elements such inline images, anchor tags, and links, add the `redact` tag attrib"
        },
        {
          "info": {
            "name": "Zendesk Get  Api V2 Tickets Ticket_id Comments",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/api/v2/tickets/:ticket_id/comments",
            "params": [
              {
                "name": "include_inline_images",
                "value": "",
                "type": "query",
                "description": "Default is false. When true, inline images are also listed as attachments in the response"
              },
              {
                "name": "include",
                "value": "",
                "type": "query",
                "description": "Accepts \"users\". Use this parameter to list email CCs by side-loading users. Example: `?include=users`. **Note**: If the comment source is email, a deleted user will be represented as the CCd email address. If the comment source is anything else, a deleted user will be represented as the user name."
              }
            ]
          },
          "docs": "Returns the comments added to the ticket.\n\nEach comment may include a `content_url` for an attachment or a `recording_url` for a voice comment that points to a file that may be hosted externally. For security reasons, take care not to inadvertently send Zendesk authentication credentials to third parties when attempting to access these files. See [Working with url properties](/documentation/ticketing/managing-tickets/working-with-url-properties).\n\n#### Pagination\n\n- Cursor pagination (recommende"
        },
        {
          "info": {
            "name": "Zendesk Put  Api V2 Tickets Ticket_id Comments Ticket_comment_id Make_private",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "{{baseUrl}}/api/v2/tickets/:ticket_id/comments/:ticket_comment_id/make_private"
          },
          "docs": "#### Allowed For\n\n* Agents\n"
        },
        {
          "info": {
            "name": "Zendesk Put  Api V2 Tickets Ticket_id Comments Ticket_comment_id Redact",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "{{baseUrl}}/api/v2/tickets/:ticket_id/comments/:ticket_comment_id/redact"
          },
          "docs": "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\n"
        },
        {
          "info": {
            "name": "Zendesk Get  Api V2 Tickets Ticket_id Comments Count",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/api/v2/tickets/:ticket_id/comments/count"
          },
          "docs": "Returns an approximate count of the comments added to the ticket. If the count exceeds 100,000, the count will return a cached result.  This cached result will update every 24 hours.\n\nThe `count[refreshed_at]` property is a timestamp that indicates when the count was last updated.\n\n**Note**: When the count exceeds 100,000, `count[refreshed_at]` may occasionally be null.\nThis indicates that the count is being updated in the background, and `count[value]` is limited to 100,000 until the update is "
        }
      ]
    }
  ],
  "bundled": true
}