Wiedervorlagen
6 Endpunkte unter /api/rest/2.0
Reminders/follow-ups for customers
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 |
/reminds |
List all reminds |
POST |
/reminds |
Create a remind |
GET |
/reminds/{id} |
Get a remind |
PUT |
/reminds/{id} |
Update a remind |
PATCH |
/reminds/{id} |
Partially update a remind |
DELETE |
/reminds/{id} |
Delete a remind |
Felder
Diese Felder liefert die API zu Wiedervorlagen. 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 | Associated customer ID |
person_id |
integer | Associated person ID (0 if none) |
user_id |
integer | User ID responsible for the reminder |
division_id |
integer | Division ID responsible for the reminder |
project_id |
integer | Associated project ID |
sale_id |
integer | Associated sale ID |
aim_id |
integer | Goal/aim ID |
activity_id |
integer | Activity type ID |
linked_action_id |
integer | Linked action ID when completed |
date |
date-time | Date and time for the reminder |
subject |
string | Subject/title of the reminder |
recurring |
string | Recurring pattern (empty = not recurring) |
active |
boolean | Whether the reminder is active (not completed) |
priority |
integer | Priority level (0 = normal) |
defer |
boolean | Whether the reminder is deferred |
date_moved |
integer | Number of times the date was moved |
modtoken |
string | Module token (sheet, message, matchingResult, task) |
mod_id |
integer | Module record ID |
external_id |
string | External import ID |
remind_token |
string | Unique remind token |
created_at |
date-time | Creation timestamp |
created_by |
integer | ID of user who created the record |
updated_at |
date-time | Last modification timestamp |
updated_by |
integer | ID of user who last modified the record |
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.