Documentation

Learn TicketsX faster

Setup guides, the full command reference, Premium features, and the REST API in one place.

13.11

Update a Panel

PATCH/<guild_id>/api/panels/<panel_id>

Change a panel’s setup: name, embed message, colour, button styling, and whether it ignores auto close. The live panel message in Discord is refreshed automatically. Requires the `manage_panels` permission (off by default).

Request Body (all fields optional; send only what you want to change)

NameTypeRequiredDescription
panel_titlestring|null
optional
Embed title (max 256 chars). Send null to clear.
panel_descriptionstring|null
optional
Embed description (max 4096 chars). Send null to clear.
panel_contentstring|null
optional
Plain-text content above the embed (max 2000 chars). Send null to clear.
panel_footerstring|null
optional
Embed footer text (max 2048 chars). Send null to clear.
panel_colorstring|null
optional
Embed colour as a hex string, e.g. #5865F2. Send null to clear.
panel_image_urlstring|null
optional
Embed image as an http(s) URL. Send null to clear.
panel_thumbnail_urlstring|null
optional
Embed thumbnail as an http(s) URL. Send null to clear.
panel_namestring
optional
Panel name used for ticket naming (max 100 chars). Single panels only.
button_textstring|null
optional
Button label (max 80 chars). Single panels only.
button_colorstring
optional
Button style: primary, secondary, success, or danger. Single panels only.
button_emojistring|null
optional
Button emoji (unicode or custom emoji ID). Single panels only.
disabledboolean
optional
Disable or re-enable the panel. Single panels only.
bypass_auto_closeboolean
optional
Leave tickets from this panel out of auto close, even when auto close is on for the server. Single panels only.
dropdown_placeholderstring|null
optional
Dropdown placeholder text (max 150 chars). Multi panels only.

Structural settings (panel channel, ticket category, mention role, forms, support teams) cannot be changed through the API; use the dashboard for those. The response includes message_refreshed; if it is false (or you changed dropdown_placeholder on a multi panel), call Resend a Panel to update the Discord message.

Panels that use a component layout reject panel_title, panel_description, panel_content, panel_footer, panel_color, panel_image_url and panel_thumbnail_url with a 400 error. Edit their layout in the dashboard instead.

Example request
curl -X PATCH \
  -H "Authorization: Bearer <API_TOKEN>" \
  -H "Content-Type: application/json" \
  -d '{"panel_title":"Contact Support","panel_color":"#57F287","button_text":"Get Help","button_color":"success"}' \
  https://api.ticketsx.xyz/<guild_id>/api/panels/<panel_id>
Example response
{
  "message": "Panel updated",
  "message_refreshed": true,
  "panel": {
    "PanelId": 1,
    "Type": "single",
    "PanelName": "Support",
    "PanelMessage": {
      "PanelTitle": "Contact Support",
      "PanelColor": "#57F287",
      "ButtonText": "Get Help",
      "ButtonColor": "success"
    }
  }
}