Merge · Schema

CommentRequest

# The Comment Object ### Description The `Comment` object is used to represent a comment on a ticket. ### Usage Example TODO

IntegrationsPlatformUnified APIAgent HandlerLLM Gateway

Properties

Name Type Description
user stringnull The author of the Comment, if the author is a User. If the third party does not support specifying an author, we will append "[Posted on behalf of {name}]" to the comment.
contact stringnull The author of the Comment, if the author is a Contact.If the third party does not support specifying an author, we will append "[Posted on behalf of {name}]" to the comment.
body stringnull The comment's text body.
html_body stringnull The comment's text body formatted as html.
ticket stringnull The ticket associated with the comment.
is_private booleannull Whether or not the comment is internal.
integration_params objectnull
linked_account_params objectnull
View JSON Schema on GitHub

JSON Schema

merge-commentrequest-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/CommentRequest",
  "title": "CommentRequest",
  "type": "object",
  "properties": {
    "user": {
      "type": [
        "string",
        "null"
      ],
      "format": "uuid",
      "description": "The author of the Comment, if the author is a User. If the third party does not support specifying an author, we will append \"[Posted on behalf of {name}]\" to the comment."
    },
    "contact": {
      "type": [
        "string",
        "null"
      ],
      "format": "uuid",
      "description": "The author of the Comment, if the author is a Contact.If the third party does not support specifying an author, we will append \"[Posted on behalf of {name}]\" to the comment."
    },
    "body": {
      "type": [
        "string",
        "null"
      ],
      "description": "The comment's text body."
    },
    "html_body": {
      "type": [
        "string",
        "null"
      ],
      "description": "The comment's text body formatted as html."
    },
    "ticket": {
      "type": [
        "string",
        "null"
      ],
      "format": "uuid",
      "description": "The ticket associated with the comment. "
    },
    "is_private": {
      "type": [
        "boolean",
        "null"
      ],
      "description": "Whether or not the comment is internal."
    },
    "integration_params": {
      "type": [
        "object",
        "null"
      ],
      "additionalProperties": {
        "description": "Any type"
      }
    },
    "linked_account_params": {
      "type": [
        "object",
        "null"
      ],
      "additionalProperties": {
        "description": "Any type"
      }
    }
  },
  "description": "# The Comment Object\n### Description\nThe `Comment` object is used to represent a comment on a ticket.\n\n### Usage Example\nTODO"
}