Kampagnen
10 Endpunkte unter /api/rest/2.0
Projects/Campaigns for customer segmentation
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 |
/projects |
List all projects |
POST |
/projects |
Create a project |
POST |
/projects/blueprint |
Import a project from a blueprint |
GET |
/projects/blueprint/schema |
Get the project blueprint JSON Schema |
GET |
/projects/{id} |
Get a project |
PUT |
/projects/{id} |
Update a project |
PATCH |
/projects/{id} |
Partially update a project |
DELETE |
/projects/{id} |
Delete a project |
GET |
/projects/{id}/blueprint |
Export a project as a blueprint |
POST |
/projects/{id}/blueprint |
Update a project from a blueprint |
Felder
Diese Felder liefert die API zu Kampagnen. 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 | Project/campaign name |
description |
string | Project description |
active |
boolean | Whether the project is active |
sort |
integer | Sort order |
amount_label |
string | Label for amount field (null = disabled) |
amount_unit |
string | Unit for amount field |
user_id |
integer | Owner user ID (0 = all users) |
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.