id-of-ticket-comments-post

restish dci id-of-ticket-comments-post ticketId

Adds a comment to an existing support request. For customers, comments are always public. For DoiT employees, comments can be marked as private (internal notes) by setting the private field to true.

Request

Content-Type: application/json

Schema

{
  "type": "object",
  "description": "Request body for adding a comment to a support ticket.",
  "required": [
    "body"
  ],
  "properties": {
    "body": {
      "type": "string",
      "description": "The text content of the comment. Must not be empty."
    },
    "private": {
      "type": "boolean",
      "description": "If true, creates a private internal note. Only honored for DoiT employees; ignored for customers.",
      "default": false
    }
  }
}

Responses

201 (application/json)

Created - Comment added to the support request.

{
  "type": "object",
  "description": "A comment on a support ticket.",
  "properties": {
    "id": {
      "type": "integer",
      "description": "Comment ID.",
      "format": "int64"
    },
    "body": {
      "type": "string",
      "description": "The text content of the comment."
    },
    "author": {
      "type": "string",
      "description": "Email address of the comment author."
    },
    "created": {
      "type": "integer",
      "description": "The time when this comment was created, in milliseconds since the epoch.",
      "format": "int64"
    },
    "attachments": {
      "type": "array",
      "description": "File attachments on the comment.",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "integer",
            "format": "int64"
          },
          "file_name": {
            "type": "string"
          },
          "content_url": {
            "type": "string"
          }
        }
      }
    }
  }
}

400 (application/json)

Bad Request - The server cannot process the request, often due to a malformed request.

{
  "type": "object",
  "description": "Standard error response structure.",
  "properties": {
    "error": {
      "type": "string",
      "description": "Detailed error message."
    }
  }
}

401 (application/json)

Unauthorized - Invalid API key.

{
  "type": "object",
  "description": "Standard error response structure.",
  "properties": {
    "error": {
      "type": "string",
      "description": "Detailed error message."
    }
  }
}

403 (application/json)

Forbidden - The client is not authorized to perform the request.

{
  "type": "object",
  "description": "Standard error response structure.",
  "properties": {
    "error": {
      "type": "string",
      "description": "Detailed error message."
    }
  }
}

404 (application/json)

Not Found - The requested resource does not exist.

{
  "type": "object",
  "description": "Standard error response structure.",
  "properties": {
    "error": {
      "type": "string",
      "description": "Detailed error message."
    }
  }
}

Aliases: id-of-ticket-comments-post, idofticketcommentspost