Create Support Ticket Comment

POST https://api.suger.cloud/org/{orgId}/support/ticket/{ticketId}/comment

create support ticket comment

Parameters

Name	In	Type	Required	Description
`orgId`	path	string	yes	Organization ID
`ticketId`	path	string	yes	Ticket ID

Request Body

Required. Content-Type: application/json · Schema: SupportTicketComment

SupportTicketComment fields:

Field	Type	Required	Description
`comment`	array<SupportTicketCommentDetail>	no
`comment_text`	string	no	When creating a new comment, only CommentText is required.
`creator`	SupportTicketUser	no
`date`	string	no
`id`	string	no

SupportTicketCommentDetail fields:

Field	Type	Required
`attachment`	SupportTicketAttachment	no
`frame`	SupportTicketFrame	no
`image`	SupportTicketImage	no
`text`	string	no
`type`	string	no

SupportTicketUser fields:

Field	Type	Required	Description
`email`	string	no
`id`	string	no	The Suger user ID.
`isSugerEmployee`	boolean	no	Whether the user is a Suger employee.
`profilePicture`	string	no
`username`	string	no

SupportTicketAttachment fields:

Field	Type	Required
`date`	string	no
`id`	string	no
`mimetype`	string	no
`size`	integer	no
`thumbnail_large`	string	no
`thumbnail_medium`	string	no
`thumbnail_small`	string	no
`title`	string	no
`url`	string	no

SupportTicketFrame fields:

Field	Type	Required	Description
`id`	string	no
`url`	string	no

SupportTicketImage fields:

Field	Type	Required
`extension`	string	no
`id`	string	no
`name`	string	no
`thumbnail_large`	string	no
`thumbnail_medium`	string	no
`thumbnail_small`	string	no
`title`	string	no
`type`	string	no
`url`	string	no

Responses

200 — OK

Content-Type: application/json · Schema: SupportTicketComment

SupportTicketComment fields:

Field	Type	Required	Description
`comment`	array<SupportTicketCommentDetail>	no
`comment_text`	string	no	When creating a new comment, only CommentText is required.
`creator`	SupportTicketUser	no
`date`	string	no
`id`	string	no

SupportTicketCommentDetail fields:

Field	Type	Required
`attachment`	SupportTicketAttachment	no
`frame`	SupportTicketFrame	no
`image`	SupportTicketImage	no
`text`	string	no
`type`	string	no

SupportTicketUser fields:

Field	Type	Required	Description
`email`	string	no
`id`	string	no	The Suger user ID.
`isSugerEmployee`	boolean	no	Whether the user is a Suger employee.
`profilePicture`	string	no
`username`	string	no

SupportTicketAttachment fields:

Field	Type	Required
`date`	string	no
`id`	string	no
`mimetype`	string	no
`size`	integer	no
`thumbnail_large`	string	no
`thumbnail_medium`	string	no
`thumbnail_small`	string	no
`title`	string	no
`url`	string	no

SupportTicketFrame fields:

Field	Type	Required	Description
`id`	string	no
`url`	string	no

SupportTicketImage fields:

Field	Type	Required
`extension`	string	no
`id`	string	no
`name`	string	no
`thumbnail_large`	string	no
`thumbnail_medium`	string	no
`thumbnail_small`	string	no
`title`	string	no
`type`	string	no
`url`	string	no

400 — Bad request error

Content-Type: application/json

500 — Internal server error

Content-Type: application/json

Example

Generated from this operation's schema. Values are placeholders — substitute your own ids, and set SUGER_TOKEN to a bearer token from the OAuth client-credentials exchange.

Request

curl -X POST 'https://api.suger.cloud/org/{orgId}/support/ticket/{ticketId}/comment' \
  -H "Authorization: Bearer $SUGER_TOKEN" \
  -H 'Content-Type: application/json' \
  -d '{
  "comment": [
    {
      "attachment": {
        "date": "2026-01-31T12:00:00Z",
        "id": "01H0000000000000000000",
        "mimetype": "string",
        "size": 1,
        "thumbnail_large": "string",
        "thumbnail_medium": "string",
        "thumbnail_small": "string",
        "title": "string",
        "url": "https://example.com"
      },
      "frame": {
        "id": "01H0000000000000000000",
        "url": "https://example.com"
      },
      "image": {
        "extension": "string",
        "id": "01H0000000000000000000",
        "name": "Acme Corp",
        "thumbnail_large": "string",
        "thumbnail_medium": "string",
        "thumbnail_small": "string",
        "title": "string",
        "type": "string",
        "url": "https://example.com"
      },
      "text": "string",
      "type": "string"
    }
  ],
  "comment_text": "string",
  "creator": {
    "email": "buyer@example.com",
    "id": "01H0000000000000000000",
    "isSugerEmployee": true,
    "profilePicture": "string",
    "username": "Acme Corp"
  },
  "date": "2026-01-31T12:00:00Z",
  "id": "01H0000000000000000000"
}'

Response — 200

{
  "comment": [
    {
      "attachment": {
        "date": "2026-01-31T12:00:00Z",
        "id": "01H0000000000000000000",
        "mimetype": "string",
        "size": 1,
        "thumbnail_large": "string",
        "thumbnail_medium": "string",
        "thumbnail_small": "string",
        "title": "string",
        "url": "https://example.com"
      },
      "frame": {
        "id": "01H0000000000000000000",
        "url": "https://example.com"
      },
      "image": {
        "extension": "string",
        "id": "01H0000000000000000000",
        "name": "Acme Corp",
        "thumbnail_large": "string",
        "thumbnail_medium": "string",
        "thumbnail_small": "string",
        "title": "string",
        "type": "string",
        "url": "https://example.com"
      },
      "text": "string",
      "type": "string"
    }
  ],
  "comment_text": "string",
  "creator": {
    "email": "buyer@example.com",
    "id": "01H0000000000000000000",
    "isSugerEmployee": true,
    "profilePicture": "string",
    "username": "Acme Corp"
  },
  "date": "2026-01-31T12:00:00Z",
  "id": "01H0000000000000000000"
}

Error — 400

"string"

View as Markdown · Interactive API reference

Spotted something wrong or out of date on this page? Tell us and we'll correct it.