Create Inquiry

Create Inquiry

Creates a new inquiry from the provided data, associating it within the requester's scope.

Module: Inquiries

Returns: Inquiries → Inquiries → InquiryRead (single)

Authorization

Required Token Scopes: Platform (0)

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

Required Permissions: Create (0)

This will be evaluated against your used access token.

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

The ID of the source of the inquiry (InquirySource).

int32 | null

The ID of the category of the inquiry.

string | null

The subject of the inquiry.

string
required

The main report or description of the inquiry.

string | null

The response provided when the inquiry is rejected.

string | null

The response provided when the inquiry is completed.

int32 | null
enum

Possible values:

  • 0 = Unknown
  • 10 = Low
  • 20 = Middle
  • 30 = High
Allowed:
int32
required

The ID of the party connected to the inquiry. Reporter of the inquiry, e.g. tenant/owner/contractor.

int32
required

The ID of the party that receives the inquiry. Usually the PropertyManager.

int32 | null

The ID of the property connected to the inquiry.

int32 | null

The ID of the unit connected to the inquiry, has to be a unit of the given connected property.

int32 | null

The ID of the process associated with the inquiry.

int32 | null

The ID of the UserTask associated with the inquiry. Note: Will be renamed to AssociatedUserTaskId in future API-Versions.

int32 | null
enum
Defaults to 0

Possible values:

  • 0 = Unread
  • 1 = Accepted
  • 2 = Rejected
  • 3 = Open
  • 4 = InProgress
  • 5 = WaitingForAnswer
Allowed:
int32 | null

The ID of the account that read the inquiry and marked the inquiry as accepted/rejected.

date-time | null

The optional due date of the inquiry.

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).

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:
application/json