Notify Accounts

⚠️ Experimental — this endpoint is subject to change and may be altered or removed without a new API version. Do not rely on it in production integrations.

Notify Accounts

Points colleagues to the inquiry with a templated system e-mail, sent to each account's own login address and linking to the inquiry on the platform. Every account has to belong to your own party, already be able to access the inquiry — grant access via accessible-by-accounts first — and have a real e-mail address, and your branding has to have a template for this notification. Either all accounts are notified or none are: if any of them does not qualify the whole request is rejected and nothing is sent. Works for inquiries in any status and changes nothing about the inquiry itself. The mails are queued, not sent synchronously, and nothing beyond the mail queue is recorded.

Module: Inquiries

Returns: Void

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2)

Required Account Permission: ReadInquiry (135)

This will be evaluated against your used access token.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
int32
required
Body Params
accountIds
array of int32s
required

The accounts to notify, each receiving the mail at its own login address. Every account has to belong
to your own party, already be able to access the inquiry and have a real e-mail address. Duplicate ids
are ignored and at most 100 distinct ids are accepted.

accountIds*
Headers
string

Language preference header. Allowed languages: German (en-DE).

string
Defaults to 2.0

API version to use (1 or 2) either with trailing .0 or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).

string
enum
Defaults to application/json

Generated from available response content types

Allowed:
string
enum
Defaults to application/json

Generated from available request content types

Allowed:
Responses

401

Error: Unauthorized

Language
Credentials
Bearer
JWT
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
text/plain
application/json
text/json