Prepare Custom Email Reply

⚠️ 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.

Prepare Custom Email Reply

Prepares the custom e-mail reply to the inquiry's connected party. Nothing is sent by this request: the reply is delivered when the inquiry is closed, and it then replaces the standard system e-mail notification for the closing (the app push is still sent). Only inquiries that are not closed yet can be prepared for, and an inquiry holds exactly one custom reply — preparing again replaces the previously prepared one instead of sending a second mail. Deleting the inquiry, or DELETE on this resource, discards it and restores the standard notification. Prepared replies are short-lived by design, so make this request right before closing the inquiry, which is what triggers delivery: one that is left unreleased is discarded by garbage collection an hour after it was prepared. Address the reply with a current e-mail contact of the inquiry's connected party; search /api/contact-details filtered by that party and contact type 3 for the ones available.

Module: Inquiries

Returns: Inquiries → Inquiries → InquiryCustomEmailReplyResponse (single)

Authorization

Required Token Scopes: Platform (0)

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

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
string
required

Mail subject.

string
required

Mail body (HTML), sent verbatim.

string | null

Additional visible recipients as a comma-separated address list.

string | null

Additional hidden recipients as a comma-separated address list.

int32
required

The mailbox to send from. Must be one the caller may use — a mailbox of their own party, or a personal
one of their own account.

attachmentFileIds
array of int32s | null

Files to attach, in the given order. Each has to be accessible to the caller.

Attachment size is not validated here, and two limits outside this API apply. The mail server
behind the chosen EMailSenderSettingId imposes its own maximum message size, which is
under the sender's control; and the recipient's mail provider imposes one too, which is not. A reply
that exceeds either is rejected at delivery time, long after this request succeeded, so keep the total
attachment size modest and link to large files instead.

attachmentFileIds
int32
required

The e-mail contact of the inquiry's connected party to send to. Search
/api/contact-details filtered by that party and contact type 3 (e-mail) for the available ones.

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