Dokumentation

Lär dig TicketsX snabbare

Guider, alla kommandon, Premium-funktioner och REST-API:et på ett ställe.

13.11

Uppdatera en panel

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

Ändrar en panels uppsättning: namn, inbäddat meddelande, färg, knappens utseende och om den hoppar över automatisk stängning. Panelmeddelandet i Discord uppdateras automatiskt. Kräver behörigheten `manage_panels` (av som standard).

Anropets kropp (alla fält är valfria; skicka bara det du vill ändra)

NamnTypObligatoriskBeskrivning
panel_titlestring|null
valfritt
Rubrik i det inbäddade meddelandet (högst 256 tecken). Skicka null för att tömma.
panel_descriptionstring|null
valfritt
Beskrivning i det inbäddade meddelandet (högst 4096 tecken). Skicka null för att tömma.
panel_contentstring|null
valfritt
Vanlig text ovanför det inbäddade meddelandet (högst 2000 tecken). Skicka null för att tömma.
panel_footerstring|null
valfritt
Sidfotstext i det inbäddade meddelandet (högst 2048 tecken). Skicka null för att tömma.
panel_colorstring|null
valfritt
Färg på det inbäddade meddelandet som hexsträng, till exempel #5865F2. Skicka null för att tömma.
panel_image_urlstring|null
valfritt
Bild i det inbäddade meddelandet som http(s)-URL. Skicka null för att tömma.
panel_thumbnail_urlstring|null
valfritt
Miniatyr i det inbäddade meddelandet som http(s)-URL. Skicka null för att tömma.
panel_namestring
valfritt
Panelnamnet som används vid namngivning av ärenden (högst 100 tecken). Bara enkla paneler.
button_textstring|null
valfritt
Knapptext (högst 80 tecken). Bara enkla paneler.
button_colorstring
valfritt
Knappstil: primary, secondary, success eller danger. Bara enkla paneler.
button_emojistring|null
valfritt
Knappemoji (unicode eller ID för egen emoji). Bara enkla paneler.
disabledboolean
valfritt
Stänger av eller slår på panelen igen. Bara enkla paneler.
bypass_auto_closeboolean
valfritt
Lämnar ärenden från den här panelen utanför automatisk stängning, även när den är på för servern. Bara enkla paneler.
dropdown_placeholderstring|null
valfritt
Platshållartext i rullgardinsmenyn (högst 150 tecken). Bara flerknappspaneler.

Strukturella inställningar (panelens kanal, ärendekategori, roll att pinga, formulär, supportteam) går inte att ändra via API:et; använd panelen för dem. Svaret innehåller message_refreshed; är värdet false (eller om du ändrat dropdown_placeholder på en flerknappspanel) anropar du Skicka en panel igen för att uppdatera meddelandet i Discord.

Paneler som använder en komponentlayout avvisar panel_title, panel_description, panel_content, panel_footer, panel_color, panel_image_url och panel_thumbnail_url med felet 400. Ändra deras layout i panelen i stället.

Exempelanrop
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>
Exempelsvar
{
  "message": "Panel updated",
  "message_refreshed": true,
  "panel": {
    "PanelId": 1,
    "Type": "single",
    "PanelName": "Support",
    "PanelMessage": {
      "PanelTitle": "Contact Support",
      "PanelColor": "#57F287",
      "ButtonText": "Get Help",
      "ButtonColor": "success"
    }
  }
}