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)
activatable_type)Typ
Beschreibung
Message
Ein- und ausgehende E-Mails
Task
Mit Task sind diverse Aktivitätstypen gemeint, wie Notizen, Aufgaben, Termine, Briefe, Absagen
Policy
Policies sind Nachweise über die Widerrufsbelehrung oder Kontakterlaubnis. Mehr Infos gibt es hier.
Aktivitäten lesen
GET https://api.propstack.de/v1/activities
Query Parameters
expand
Boolean
um das ausführliche JSON (einschließlich custom Felder) zu erhalten
order
String
Aufsteigend oder absteigend sortieren. Entweder asc oder desc
category_id
Integer
ID des Aktivitätstypen
category_ids
Integer[]
IDs der Aktivitätstypen
client_id
integer
ID des Kontaktes
client_ids
Integer[]
IDs der Kontakte
property_id
Integer
ID des Objektes
property_ids
Integer[]
IDs der Objekte
project_id
Integer
ID des Projektes
project_ids
Integer[]
IDs der Projekte
item_type
String
Typ der Aktivität. Eines von message, note, reminder, event, policy, cancelation, decision, sms, letter
broker_id
Integer
ID des Besitzers der Aktivität (Bei Notizen, Terminen, Aufgaben der, dem die Aktivität "zugewiesen" wurde)
creator_id
Integer
ID des Erstellers der Aktivität
starts_at_from
String
Format: 2022-12-07T10:00:00+01:00
starts_at_to
String
Format: 2022-12-07T23:59:59+01:00
original_created_at_from
String
Format: 2022-12-07T10:00:00+01:00
original_created_at_to
String
Format: 2022-12-07T23:59:59+01:00
only_inquiries
Boolean
auf true oder 1 setzen, um nur Aktivitäten vom Typ "Anfrage" zu erhalten
not_completed
Boolean
um nur unvollständige Aktivitäten zu erhalten
reason_id
Integer
ID des Absagegrundes der Aktivität
reason_ids
Integer[]
IDs der Absagegründe der Aktivität
group_ids
Integer[]
IDs der Merkmale
team_ids
Integer[]
IDs der Abteilungen
source_id
Integer
ID der Anfrage-Quelle
blocked
Boolean
Ob der angehängte Kunde gesperrt ist oder nicht
{
"data": [
{
"id": 123,
"broker_id": 12,
"client_ids": [
123401
],
"property_ids": [
4321
],
"project_ids": [],
"client_names": [
"Stefanie Mante"
],
"property_names": [
"CLA-1050"
],
"project_names": [],
"conversation_type": "note",
"sender_type": null,
"source_id": null,
"creator_id": 123,
"category_id": null,
"reason_id": null,
"created_at": "2019-01-15T01:22:37.619+01:00",
"starts_at": null,
"price": null,
"group_ids": [],
"state": "neutral",
"title": "Eingehender Anruf um 18:00",
"access_broker_ids": null,
"access_department_ids": null,
"blocked": false,
"comments_count": 0,
"attachments_count": 0,
"done": false,
"outgoing": false,
"tracking_size": 0,
"unread_tracking_size": 0,
"attachments": 0,
"comment_size": 0
},
],
"meta": {
"total_count": 10205
}
}Aktivitäten lassen sich paginieren über die Parameter page und per. Standardmäßig werden die ersten 20 Aktivitäten angezeigt.
Einzelne Aktivität lesen
GET https://api.propstack.de/v1/activities/:id
{
"id": 41711,
"activatable_type": "Task",
"activatable": {
// je nachdem was activatable_type ist,
// .. kommt hier das Objekt zur E-Mail oder zum Task
}
}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
Falls Task eine Absage ist:
Attribut
Typ
Beschreibung
reservation_reason_id
integer
ID des Absagegrundes
Aktivitätstypen lesen
GET https://api.propstack.de/v1/activity_types
Aktivitätstypen sind wie Kategorien zu verstehen. Eine Aktivität kann zu einer oder gar keiner Kategorie gehören.
{
"data": [
{
"id": 35,
"name": "Anfrage",
"category": "message"
},
{
"id": 38,
"name": "Angebot",
"category": "message"
},
{
"id": 102,
"name": "Notartermin",
"category": "event"
},
{
"id": 386,
"name": "Marketing: Mailing",
"category": "note"
},
{
"id": 73,
"name": "Anruf",
"category": "reminder"
}
]
}Absagegründe lesen
GET https://api.propstack.de/v1/reservation_reasons
[
{
"id": 1,
"name": "Finanzierung"
},
{
"id": 2,
"name": "Ausstattung"
},
{
"id": 3,
"name": "Preis"
},
{
"id": 4,
"name": "Lage"
},
{
"id": 5,
"name": "Größe"
}
]Last updated