Zendesk · Schema

Comment

A comment on a ticket.

ChatCRMHelp CenterSellSupportT1TalkTicketingTickets

Properties

Name Type Description
id integer The ID of the comment.
type string The type of the comment.
body string The plain text body of the comment.
html_body string The HTML body of the comment.
plain_body string The plain text body with formatting stripped.
public boolean Whether the comment is public (visible to the requester).
author_id integer The ID of the comment author.
attachments array Attachments on the comment.
created_at string When the comment was created (ISO 8601).
View JSON Schema on GitHub

JSON Schema

zendesk-support-comment-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "Comment",
  "type": "object",
  "description": "A comment on a ticket.",
  "properties": {
    "id": {
      "type": "integer",
      "description": "The ID of the comment."
    },
    "type": {
      "type": "string",
      "description": "The type of the comment."
    },
    "body": {
      "type": "string",
      "description": "The plain text body of the comment."
    },
    "html_body": {
      "type": "string",
      "description": "The HTML body of the comment."
    },
    "plain_body": {
      "type": "string",
      "description": "The plain text body with formatting stripped."
    },
    "public": {
      "type": "boolean",
      "description": "Whether the comment is public (visible to the requester)."
    },
    "author_id": {
      "type": "integer",
      "description": "The ID of the comment author."
    },
    "attachments": {
      "type": "array",
      "description": "Attachments on the comment."
    },
    "created_at": {
      "type": "string",
      "description": "When the comment was created (ISO 8601)."
    }
  }
}