Textvorlagen
8 Endpunkte unter /api/rest/2.0
Text module management - text templates for emails, messages, etc.
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-modules |
List all text-modules |
POST |
/text-modules |
Create a text-module |
GET |
/text-modules/{id} |
Get a text-module |
PUT |
/text-modules/{id} |
Update a text-module |
DELETE |
/text-modules/{id} |
Delete a text-module |
GET |
/text-modules/{id}/files |
List attached files |
POST |
/text-modules/{id}/files |
Attach a file |
DELETE |
/text-modules/{id}/files/{file_id} |
Delete an attached file |
Felder
Diese Felder liefert die API zu Textvorlagen. 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 |
|---|---|---|
category_id |
integer | Category ID |
user_id |
integer | Owner user ID (0 = shared) |
name |
string | Internal name/identifier |
subject |
string | Subject line (for emails) |
message |
string | Plain text content |
message_html |
string | HTML content |
is_html |
boolean | Whether content is HTML |
html_strict |
boolean | Use strict HTML mode |
language |
string | Language code (e.g., de, en) |
public |
boolean | Whether module is public/shared |
created_at |
date-time | Creation timestamp |
created_by |
integer | User ID who created the module |
updated_at |
date-time | Last update timestamp |
updated_by |
integer | User ID who last updated the module |
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.