Search
K
Exposé erstellen

Exposé erstellen

Startet die Generierung eines Exposés aus einem Objekt und einer Vorlage.
Die Verarbeitung läuft asynchron; die Antwort trägt zunächst status: "in_arbeit".

post

Body

application/json

ExposeAnlegen

objekt_idstringrequired

Objekt, aus dem das Exposé erzeugt wird.

Example:obj_8f2c1a

vorlage_idstringrequired

Gestaltungsvorlage des Mandanten.

Example:vrl_klassik

sprachestring

Sprache des erzeugten Dokuments.

Allowed values:deen

Default:de

abschnittearray[string]

Inhaltlicher Block des Exposés.

Allowed values:lageausstattungenergiegrundrissprovisionumgebunghistorie

notiz_internstring

Interne Bemerkung, erscheint nicht im Dokument.

<= 500 characters

Example:Eigentümerin wünscht Besichtigungen erst ab dem 1. September.

Response

application/json

Generierung angenommen

Expose

idstring

Example:exp_4d9b2e

objekt_idstring

Example:obj_8f2c1a

vorlage_idstring

Example:vrl_klassik

sprachestring

Example:de

statusstring

Lebenszyklus eines Exposés.

Allowed values:in_arbeitfertigveroeffentlichtzurueckgezogenfehlgeschlagen

Example:fertig

pdf_urlstring(uri)

Nur bei status: fertig gesetzt. Der Link ist 24 Stunden gültig.

Example:https://api.maklerportal.example/v1/exposes/exp_4d9b2e/pdf

seiteninteger

Seitenzahl des erzeugten Dokuments.

Example:6

pflichtangabenobject

Ergebnis der Prüfung anzeigepflichtiger Angaben.

Show Child Parameters
erstellt_amstring(date-time)

Example:2026-08-20T09:41:12Z

fertig_amstring | null(date-time)

Example:2026-08-20T09:41:20Z

post/exposes

Body

{ "objekt_id": "obj_8f2c1a", "vorlage_id": "vrl_klassik", "sprache": "de", "abschnitte": [ "lage", "ausstattung", "energie", "grundriss", "provision" ] }
 
application/json

Exposé abrufen

Liefert Status, Metadaten und den Prüfbericht der Pflichtangaben.

get

Path Parameters

exposeIdstringrequired

Kennung des Exposés.

Example:exp_4d9b2e

Response

application/json

Exposé

Expose

idstring

Example:exp_4d9b2e

objekt_idstring

Example:obj_8f2c1a

vorlage_idstring

Example:vrl_klassik

sprachestring

Example:de

statusstring

Lebenszyklus eines Exposés.

Allowed values:in_arbeitfertigveroeffentlichtzurueckgezogenfehlgeschlagen

Example:fertig

pdf_urlstring(uri)

Nur bei status: fertig gesetzt. Der Link ist 24 Stunden gültig.

Example:https://api.maklerportal.example/v1/exposes/exp_4d9b2e/pdf

seiteninteger

Seitenzahl des erzeugten Dokuments.

Example:6

pflichtangabenobject

Ergebnis der Prüfung anzeigepflichtiger Angaben.

Show Child Parameters
erstellt_amstring(date-time)

Example:2026-08-20T09:41:12Z

fertig_amstring | null(date-time)

Example:2026-08-20T09:41:20Z

get/exposes/{exposeId}
 
application/json

Exposé zurückziehen

Nimmt ein Exposé von allen Kanälen und markiert es als zurueckgezogen.
Das Dokument bleibt zu Nachweiszwecken abrufbar.

delete

Path Parameters

exposeIdstringrequired

Kennung des Exposés.

Example:exp_4d9b2e

Response

Zurückgezogen

delete/exposes/{exposeId}
 

Exposé als PDF laden

Liefert das gesetzte Dokument. Erst verfügbar, wenn status auf fertig steht –
vorher antwortet die API mit 409.

get

Path Parameters

exposeIdstringrequired

Kennung des Exposés.

Example:exp_4d9b2e

Response

application/pdf

PDF-Dokument

string
get/exposes/{exposeId}/pdf
 
application/pdf

Exposé veröffentlichen

Stellt das Exposé auf den gewählten Kanälen ein. Vorher werden die
Pflichtangaben geprüft.

post

Path Parameters

exposeIdstringrequired

Kennung des Exposés.

Example:exp_4d9b2e

Body

application/json
kanaelearray[string]required

Veröffentlichungskanal.

Allowed values:portalwebsitenewsletterschaufenster

>= 1 items

geplant_abstring(date-time)

Optionaler Zeitpunkt für eine spätere Veröffentlichung.

Response

application/json

Veröffentlicht bzw. eingeplant

Veroeffentlichung

expose_idstring

Example:exp_4d9b2e

statusstring

Lebenszyklus eines Exposés.

Allowed values:in_arbeitfertigveroeffentlichtzurueckgezogenfehlgeschlagen

Example:fertig

kanaelearray[object]
Show Child Parameters
veroeffentlicht_amstring(date-time)

Example:2026-08-20T09:44:03Z

post/exposes/{exposeId}/veroeffentlichen

Body

{ "kanaele": [ "portal", "website", "newsletter" ] }
 
application/json