Kampagnen-Stati
6 Endpunkte unter /api/rest/2.0
Type stages within a project/campaign
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 |
/project-types |
List all project-types |
POST |
/project-types |
Create a project-type |
GET |
/project-types/{id} |
Get a project-type |
PUT |
/project-types/{id} |
Update a project-type |
PATCH |
/project-types/{id} |
Partially update a project-type |
DELETE |
/project-types/{id} |
Delete a project-type |
Felder
Diese Felder liefert die API zu Kampagnen-Stati. 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 |
|---|---|---|
project_id |
integer | Associated project ID |
name |
string | Type name |
progress |
integer | Progress percentage (0-100) |
active |
boolean | Whether this type is active |
is_default |
boolean | Whether this is the default type for new assignments |
is_final |
boolean | Whether this is a final/end type |
effect |
string | Effect classification for reporting |
conversion_value |
integer | Conversion value in cents |
conversion_factor |
number | Conversion probability factor (0.00-1.00) |
conversion_deferred |
boolean | Whether conversion is deferred |
update_customertype_id |
integer | Customer type to set when this type is reached (0 = no change) |
show_in_cockpit |
boolean | Whether to show in cockpit/dashboard |
reason_mode |
string | Whether reason is required when setting this type |
reason_text_enabled |
boolean | Whether free text reason is enabled |
color |
string | Display color (hex, e.g. #FF0000) |
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.