Close Support Ticket

PATCH https://api.suger.cloud/org/{orgId}/support/ticket/{ticketId}/close

close support ticket

Parameters

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

Responses

200 — OK

Content-Type: application/json · Schema: SupportTicket

SupportTicket fields:

Field	Type	Required	Description
`assignee`	string	no	Assignee is the Suger identity.user id assigned by staff (cs-github-issues US4). Additive to the response; empty when unassigned.
`assigneeName`	string	no	AssigneeName is Assignee resolved to a person — "First Last", else the email, else the raw id. Read-only, filled by the staff list/detail handlers: the cockpit lists tickets across every org, and an assignee is a SUGER staffer who is frequently not a member of the org whose ticket they hold, so the console cannot resolve the id from any one org's directory.
`attachments`	array<SupportTicketAttachment>	no
`closeTime`	string	no
`comments`	array<SupportTicketComment>	no
`creationTime`	string	no
`creator`	string	no
`description`	string	no
`dueTime`	string	no
`id`	string	no
`name`	string	no
`organizationId`	string	no
`organizationName`	string	no	OrganizationName is OrganizationID resolved to the customer's name, for the same reason: the cross-org cockpit would otherwise render an opaque id per row.
`priority`	SupportTicketPriority	no
`status`	SupportTicketStatus	no
`taskType`	SupportTicketTaskType	no
`watchers`	array<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

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

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 PATCH 'https://api.suger.cloud/org/{orgId}/support/ticket/{ticketId}/close' \
  -H "Authorization: Bearer $SUGER_TOKEN"

Response — 200

{
  "assignee": "string",
  "assigneeName": "Acme Corp",
  "attachments": [
    {
      "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"
    }
  ],
  "closeTime": "2026-01-31T12:00:00Z",
  "comments": [
    {
      "comment": [
        {
          "attachment": {},
          "frame": {},
          "image": {},
          "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"
    }
  ],
  "creationTime": "2026-01-31T12:00:00Z",
  "creator": "string",
  "description": "string",
  "dueTime": "2026-01-31T12:00:00Z",
  "id": "01H0000000000000000000",
  "name": "Acme Corp",
  "organizationId": "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.