Betreuergruppen
6 Endpunkte unter /api/rest/2.0
Sales agents/territories (Betreuergruppen)
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 |
/agents |
List all agents |
POST |
/agents |
Create a agent |
GET |
/agents/{id} |
Get a agent |
PUT |
/agents/{id} |
Update a agent |
PATCH |
/agents/{id} |
Partially update a agent |
DELETE |
/agents/{id} |
Delete a agent |
Felder
Diese Felder liefert die API zu Betreuergruppen. 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 |
|---|---|---|
parent_id |
integer | Parent agent ID for hierarchical structure (0 = root) |
name |
string | Agent/territory name |
external_id |
string | External ID for integration |
ratio |
integer | Distribution ratio/weight for lead assignment (0 = disabled) |
color |
string | Display color (hex format, e.g., #FF5500) |
is_default |
boolean | Is this the default agent for new customers |
sort |
integer | Sort order (managed by system) |
layer |
integer | Hierarchy layer/depth (managed by system) |
customer_import_id |
integer | Associated customer import configuration ID |
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.