Benutzerdefiniertes Feld erstellen
Erstellt eine neue Definition für ein benutzerdefiniertes Feld.
POST /api/custom-fields
Erfordert die Rolle admin (oder einen globalen Admin). Editoren und Nur-Lese-Benutzer erhalten 403.
Anfrage (Request Body)
| Feld | Typ | Erforderlich | Standard | Beschreibung |
|---|---|---|---|---|
organizationId | number | Nein | aus der Session | Muss, falls angegeben, deine eigene Organisation sein |
name | string | Ja | - | Anzeigename, 1 bis 100 Zeichen |
fieldKey | string | Nein | auto aus name | Eindeutiger Schlüssel, max. 100 Zeichen (automatisch normalisiert: Kleinbuchstaben, nicht-alphanumerisch → _) |
fieldType | string | Nein | text | Einer von text, number, email, url, select |
isRequired | boolean | Nein | false | Ob das Feld erforderlich ist |
displayOrder | number | Nein | 0 | Sortierreihenfolge, Ganzzahl 0 bis 10000 |
options | string[] | Nein | [] | Optionen für den Typ select, max. 50 Einträge mit je max. 100 Zeichen |
placeholder | string|null | Nein | null | Platzhaltertext, max. 200 Zeichen |
helpText | string|null | Nein | null | Hilfetext unterhalb des Feldes, max. 500 Zeichen |
showInTable | boolean | Nein | true | In Tabellenansichten anzeigen |
Beispiel (cURL)
curl -X POST "$BASE_URL/api/custom-fields" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{
"organizationId": 1,
"name": "Environment",
"fieldType": "select",
"options": ["production", "staging", "development"],
"isRequired": true,
"showInTable": true
}'Häufige Fehler
400 Bad Requestwenn der Body die Validierung nicht besteht (unbekannterfieldType,namefehlt oder hat mehr als 100 Zeichen, mehr als 50options)403 Forbiddenwenn deine Rolle nichtadminist oderorganizationIdeine fremde Organisation nennt409 ConflictwennfieldKeyfür die Organisation bereits existiert
Antwort (Response)
Gibt das erstellte benutzerdefinierte Feld-Objekt zurück. Siehe Fehlercodes für Fehlerantworten.
Benutzerdefinierte Felder
Definiere benutzerdefinierte Metadatenfelder, die an Kunden und Websites angehängt werden können. Benutzerdefinierte Felder unterstützen die Typen Text, Select und Multi-Select.
Benutzerdefiniertes Feld löschen
Löscht ein benutzerdefiniertes Feld per Soft-Delete (setzt isActive: false).