Create View Setting

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

Create View Setting

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

Module: View Settings

Returns: View Settings → ViewSettingRead (single)

Authorization

Required Token Scopes: Platform (0)

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

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

The ownership level a client targets when writing a view setting. The server derives the owner
columns from this plus the auth context; the client never sends owner ids.

Possible values:

  • 0 = Personal
  • 1 = PartyTemplate
  • 2 = SystemTemplate
Allowed:
int32
required

Id of the ViewSettingGroup this setting belongs to.

string | null

Client-defined identifier, unique within the selected scope and group. Must be null for groups
with Single cardinality; required for groups with Multi cardinality.

string | null

Optional free-text description of this view setting.

int32 | null

Display order within the owner and group, relevant only for groups with Multi cardinality.
Optional; defaults to 0 when omitted.

string
required

Opaque JSON payload owned by the client.

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