Propstack
Search…
Kontakte

Das Kontakt Objekt

Attribut
Typ
Beschreibung
parent_id
integer
ID zum Hauptkontakt (anhand dieses Attributes erkennt man einen Unterkontakt)
is_company
boolean
Ist der Kontakt eine Firma?
item_id
integer
autom. hochgezählte Kundennummer
salutation
string
Anrede. Eines von mr oder ms
academic_title
title
Titel, z.B. "Dr."
first_name
string
Vorname
last_name
string
Nachname
email
string
Primär-Email
home_cell
string
Handynummer
home_phone
string
Festnetznummer
office_phone
string
Geschäftliche Telefonnummer
office_cell
string
Geschäftliche Handynummer
dob
date
Geburtsdatum
birth_name
string
Geburtsname
birth_place
string
Geburtsort
birth_country
string
Geburtsland
identity_number
string
issuing_authority
string
tax_identification_number
string
rating
integer
Bewertung von 0-3
description
string
Notizfeld für Bemerkungen zum Kontakt
company
string
Unternehmen für welches der Kontakt arbeitet
position
string
Position im Unternehmen
emails
string[]
Alle E-Mail-Adressen des Kontaktes
full_salutation
string
E-Mail Anrede, z.B. "Sehr geehrter Herr Doe"
language
string
Sprache des Benutzers. Mögliche Werte: de, en, es
income
string
Einkommen
newsletter
boolean
Möchte Newsletter haben?
accept_contact
boolean
Hat Kontakterlaubnis bestätigt?
warning_notice
string
Warnhinweis, der im Kontakt auffällig angezeigt wird
client_source_id
integer
ID der Quelle des Kontaktes
client_status_id
integer
ID des Statuses des Kontaktes
archived
boolean
Kontakt archiviert?
last_contact_at
date
Letzter Kontakt mit ihm
created_at
date
Erstellungsdatum
updated_at
date
Zuletzt bearbeitet
creator_id
integer
der Benutzer, der den Kontakt angelegt hat
updater_id
integer
der Benutzer, der den Kontakt zuletzt bearbeitet hat
gdpr_status
integer
DSGVO-Status. Eines von 0, 1, 2, 3 (Keine Angabe, Ignoriert, Zugestimmt, Widerrufen)
keep_data_till
date
Speichern-bis Datum
client_reason_id
id
ID des Speichern-Grund, siehe Speicherungsgründe unten
cp_delete_request_date
date
Datum der Löschungsbeantragung vom Kontakt
custom_fields
object
Custom Felder

Assoziationen

    1.
    broker
    2.
    second_broker
    3.
    client_source
    4.
    client_status
    5.
    documents
    6.
    owned_properties
    7.
    children
get
https://api.propstack.de
/v1/contacts
Kontakte lesen

Beispiele für Anfragen nach Telefonnummer

Ist bei einem Kontakt die Telefonnummer 0157 123 456 78 hinterlegt, kann man mit folgenden Anfragen finden:
https://api.propstack.de/v1/contacts?phone_number=015712345678 oder: https://api.propstack.de/v1/contacts?phone_number=0157-123-456-78
post
https://api.propstack.de/v1
/contacts
Kontakt erstellen
Um einen Kontakt anzulegen, mit einem Vor- und Nachnamen, einer E-Mail-Adresse und der Anrede "Herr", würde der Body des Requests folgendermaßen aussehen:
1
{
2
"client": {
3
"salutation": "mr",
4
"first_name": "John",
5
"last_name": "Doe",
6
"email": "[email protected]"
7
}
8
}
Copied!
get
https://api.propstack.de
/v1/contacts/:id
Kontakt lesen

Anmerkungen:

owned_properties listet die Objekte auf, wo der Kontakt als Eigentümer eingetragen ist.
put
https://api.propstack.de
/v1/contacts/:id
Kontakt aktualisieren
Der Parameter id ist Propstacks interne ID (z.B. 2049). Wenn man aber z.B. einen anderen Identifier hat, z.B. den Token des Kontaktes, welcher ein langer String ist, kann man diesen auch als id übergeben, muss aber dann noch einen weiteren Parameter identifier hinzufügen, welcher den Wert token hat:
1
https://api.propstack.de/v1/contacts/gioWo5KczySDb1gRfT7bik52?identifier=token
Copied!
delete
https://api.propstack.de
/v1/contacts/:id
Kontakt löschen
get
https://api.propstack.de
/v1/contact_sources
Kontakt-Quellen lesen
Last modified 1mo ago