Propstack
Search
⌃K

Aktivitäten

Eine Aktivität ist ein Container für eine Message, einen Task oder eine Policy.
Aktivitäten können nicht direkt angelegt werden, sondern werden intern durch PS angelegt. Um eine Aktivität anzulegen, muss man entweder eine Message oder einen Task direkt anlegen.

Arten von Aktivitäten (activatable_type)

Typ
Beschreibung
Message
Ein- und ausgehende E-Mails
Task
Mit Task sind diverse Aktivitätstypen gemeint, wie Notizen, Aufgaben, Termine, Briefe
Policy
Policies sind Nachweise über die Widerrufsbelehrung oder Kontakterlaubnis. Mehr Infos gibt es hier.
get
https://api.propstack.de
/v1/activities
Aktivitäten lesen
Aktivitäten lassen sich paginieren über die Parameter page und per. Standardmäßig werden die ersten 20 Aktivitäten angezeigt.
get
https://api.propstack.de
/v1/activities/:id
Einzelne Aktivität lesen

Aktivität anlegen

In der Regel möchte man eine einfache Notiz anlegen, welches in Propstacks API ein "Task" wäre. Die Beschreibung für einen Task sieht wie folgt aus:

Task

Attribut
Typ
Beschreibung
title
string
Titel
note_type_id
integer
Aktivitätstyp (alle bis auf E-Mail-Typen)
body
string
Notizfeld für weitere Bemerkungen als HTML
client_ids
integer[]
Ein Array von Kontakt-IDs mit welcher die Aktivität verknüpft werden soll. In der Regel will man nur eine Kontakt-ID mitgeben
property_ids
integer[]
Ein Array von Objekt-IDs, womit die Aktivität verknüpft werden soll.
project_ids
integer[]
Ein Array von Projekt-IDs, womit die Aktivität verknüpft werden soll.
broker_id
integer
Nutzer, dem der Task zugewiesen werden soll
task_creator_id
integer
Ersteller des Tasks
task_updater_id
integer
der Nutzer, der den Task zuletzt bearbeitet hat

Falls Task eine Aufgabe ist:

Attribut
Typ
Beschreibung
due_date
date
Datum + Uhrzeit der Fälligkeit der Aufgabe
remind_at
date
Datum (vor dem due_date), wann der Zugewiesene erinnert werden soll (in Form einer E-Mail)
done
boolean
Ist die Aufgabe erledigt?

Falls Task ein Termin ist:

Attribut
Typ
Beschreibung
starts_at
date
Beginn des Termins
ends_at
date
Ende des Termins
private
boolean
Soll der Termin nur für die Teilnehmer sichtbar sein?
all_day
boolean
Ganztägiger Termin?
location
string
Ort des Termins
recurring
boolean
Wiederkehrender Termin?
rrule
string
bei wiederkehrenden Terminen der String, welcher die Regeln festlegt, in welchem Interval der Termin stattfindet. Mehr Infos hier​

Falls Task eine Anfrage ist:

Attribut
Typ
Beschreibung
client_source_id
integer
ID der Anfrage-Quelle
get
https://api.propstack.de
/v1/activity_types
Aktivitätstypen lesen
API Reference - Previous
Abteilungen
Next - API Reference
Aufgaben
Last modified 4mo ago