Dokumentasjon

Lær TicketsX raskere

Veiledninger, alle kommandoer, Premium-funksjoner og REST-API-et på ett sted.

13.11

Oppdatere et panel

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

Endrer oppsettet til et panel: navn, innfelt melding, farge, utseendet på knappen og om det hopper over automatisk lukking. Panelmeldingen i Discord blir oppdatert automatisk. Krever rettigheten `manage_panels` (av som standard).

Innholdet i kallet (alle felter er valgfrie; send bare det du vil endre)

NavnTypePåkrevdBeskrivelse
panel_titlestring|null
valgfritt
Tittel i den innfelte meldingen (høyst 256 tegn). Send null for å tømme.
panel_descriptionstring|null
valgfritt
Beskrivelse i den innfelte meldingen (høyst 4096 tegn). Send null for å tømme.
panel_contentstring|null
valgfritt
Vanlig tekst over den innfelte meldingen (høyst 2000 tegn). Send null for å tømme.
panel_footerstring|null
valgfritt
Bunntekst i den innfelte meldingen (høyst 2048 tegn). Send null for å tømme.
panel_colorstring|null
valgfritt
Farge på den innfelte meldingen som hekstreng, for eksempel #5865F2. Send null for å tømme.
panel_image_urlstring|null
valgfritt
Bilde i den innfelte meldingen som http(s)-adresse. Send null for å tømme.
panel_thumbnail_urlstring|null
valgfritt
Miniatyr i den innfelte meldingen som http(s)-adresse. Send null for å tømme.
panel_namestring
valgfritt
Panelnavnet som blir brukt når saker får navn (høyst 100 tegn). Bare enkle paneler.
button_textstring|null
valgfritt
Knappetekst (høyst 80 tegn). Bare enkle paneler.
button_colorstring
valgfritt
Knappestil: primary, secondary, success eller danger. Bare enkle paneler.
button_emojistring|null
valgfritt
Knappemoji (unicode eller ID til en egen emoji). Bare enkle paneler.
disabledboolean
valgfritt
Slår panelet av eller på igjen. Bare enkle paneler.
bypass_auto_closeboolean
valgfritt
Holder saker fra dette panelet utenfor automatisk lukking, selv når den er på for serveren. Bare enkle paneler.
dropdown_placeholderstring|null
valgfritt
Plassholdertekst i nedtrekksmenyen (høyst 150 tegn). Bare flerknappspaneler.

De strukturelle innstillingene (kanalen til panelet, sakskategori, rolle som skal varsles, skjemaer, supportteam) kan ikke endres gjennom API-et; bruk kontrollpanelet til dem. Svaret inneholder message_refreshed; er verdien false (eller har du endret dropdown_placeholder på et flerknappspanel), må du kalle Sende et panel på nytt for å oppdatere meldingen i Discord.

Paneler som bruker et komponentoppsett, avviser panel_title, panel_description, panel_content, panel_footer, panel_color, panel_image_url og panel_thumbnail_url med feilen 400. Endre oppsettet deres i kontrollpanelet i stedet.

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