Textvorlagen Kategorien
5 Endpunkte unter /api/rest/2.0
Text module category management - categories for text templates
Endpunkte
Alle Pfade sind relativ zur Basis /api/rest/2.0 Ihrer ameax-Installation. Die Antworten folgen dem JSON:API-Format mit data, links und meta.
| Methode | Pfad | Beschreibung |
|---|---|---|
GET |
/text-module-categories |
List all text-module-categorys |
POST |
/text-module-categories |
Create a text-module-category |
GET |
/text-module-categories/{id} |
Get a text-module-category |
PUT |
/text-module-categories/{id} |
Update a text-module-category |
DELETE |
/text-module-categories/{id} |
Delete a text-module-category |
Felder
Diese Felder liefert die API zu Textvorlagen Kategorien. Dazu kommen die Zusatzfelder Ihrer eigenen Installation — sie werden nach denselben Regeln geprüft wie in der Oberfläche und erscheinen in der Spezifikation Ihres Mandanten.
| Feld | Typ | Beschreibung |
|---|---|---|
name |
string | Category name |
sort |
integer | Sort order |
modules |
string | Comma-separated list of modules where this category is available (e.g., message,automailer,proceeding) |
Zugriff
Jede Anfrage braucht ein API-Token im Kopf Authorization: Bearer <token>, wahlweise als Basic-Auth mit dem Benutzernamen api und dem Token als Passwort.
Das Token hängt an einem Benutzer und erbt dessen Rechte: Was dieser Benutzer in der Oberfläche nicht sehen darf, liefert die API auch nicht. Zusätzlich lassen sich je Token ein Ablaufdatum und eine IP-Beschränkung hinterlegen. Mehr dazu auf der API-Übersicht.
Anbindung besprechen.
Sie wollen ein System anbinden und wissen nicht, ob die Schnittstelle abdeckt, was Sie brauchen? Wir schauen es uns gemeinsam an — kostenlos und ohne Verpflichtung.