Uptimeify Docs

Benutzerdefiniertes Feld aktualisieren

Aktualisiert die Definition eines benutzerdefinierten Feldes. Alle Felder sind optional.

PATCH /api/custom-fields/:id

Erfordert die Rolle admin (oder einen globalen Admin). Editoren und Nur-Lese-Benutzer erhalten 403.

Anfrage (Request Body) (alle optional)

FeldTypBeschreibung
namestringAnzeigename, 1 bis 100 Zeichen
fieldTypestringEiner von text, number, email, url, select
isRequiredbooleanOb das Feld erforderlich ist
displayOrdernumberSortierreihenfolge, Ganzzahl 0 bis 10000
optionsstring[]Optionen für den Typ select, max. 50 Einträge mit je max. 100 Zeichen
placeholderstring|nullPlatzhaltertext, max. 200 Zeichen
helpTextstring|nullHilfetext, max. 500 Zeichen
showInTablebooleanIn Tabellenansichten anzeigen
isActivebooleanSoft-Delete (auf false setzen)

Beispiel (cURL)

curl -X PATCH "$BASE_URL/api/custom-fields/1" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{ "name": "Environment", "options": ["production", "staging", "development", "qa"] }'

Häufige Fehler

  • 400 Bad Request wenn der Body die Validierung nicht besteht (unbekannter fieldType, name mit mehr als 100 Zeichen, mehr als 50 options)
  • 403 Forbidden wenn deine Rolle nicht admin ist
  • 404 Not Found wenn das Feld in deiner Organisation nicht existiert

Antwort (Response)

Gibt das aktualisierte benutzerdefinierte Feld-Objekt zurück. Siehe Fehlercodes für Fehlerantworten.

Auf dieser Seite