Kunden-Kampagnen
6 Endpunkte unter /api/rest/2.0
Customer assignments to projects with campaign status
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 |
/customer-projects |
List all customer-projects |
POST |
/customer-projects |
Create a customer-project |
GET |
/customer-projects/{id} |
Get a customer-project |
PUT |
/customer-projects/{id} |
Update a customer-project |
PATCH |
/customer-projects/{id} |
Partially update a customer-project |
DELETE |
/customer-projects/{id} |
Delete a customer-project |
Felder
Diese Felder liefert die API zu Kunden-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 |
|---|---|---|
customer_id |
integer | Customer ID |
project_id |
integer | Project/campaign ID |
person_id |
integer | Associated person ID (0 if none) |
user_id |
integer | Responsible user ID |
type_id |
integer | Current project type ID (from project-types) |
stars |
integer | Star rating (0-5) |
amount |
number | Amount value (meaning defined by project amount_label) |
reason_id |
integer | Reason ID for current status |
reason_text |
string | Free text reason for current status |
added_at |
date-time | When customer was added to project |
type_changed_at |
date-time | When type was last changed |
type_changed_by |
integer | User who last changed the type |
last_activity_at |
date-time | Last activity timestamp |
reason_changed_at |
date-time | When reason was last changed |
reason_changed_by |
integer | User who last changed the reason |
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.