/api/accounts

post

https://api.facilioo.de/api/accounts

Create Account

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

Module: Authentication

Returns: Identity → Accounts → AccountRead (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.

Body Params

string

required

The unique login email address of the account. Must be globally unique and formatted as a valid email address.

partyId

int32

required

Identifier of the Party (legal entity) the account belongs to. Required during creation and cannot be changed afterwards. User-type Parties may only contain a single account.

firstName

string | null

The first name of the account holder. Currently not changeable after account creation.

lastName

string

required

The last name of the account holder. Required during creation and currently not changeable afterwards.

themeMode

int32 | null

enum

Defaults to 2

Possible values:

0 = Light
1 = Dark
2 = System

Allowed:

isPartyAdministrator

boolean | null

Indicates whether the account should have administrative privileges within its Party. Cannot be initialized during account creation. Can only be modified by Party administrators of the same Party.

groupId

int32

required

Identifier of the account group that defines permissions and roles. Must reference an accessible existing account group.

colorId

int32 | null

deprecated

Identifier of the UI color assigned to the account. If not provided, a default color will be assigned automatically.

hasRepresentationViewForAllAccounts

boolean | null

Indicates whether the account can view representations across all accounts of the Party. Cannot be initialized during account creation. Can only be modified by Party administrators of the same Party.

isSupervisor

boolean | null

Indicates whether the account should have supervisor privileges. Cannot be initialized during account creation. Can only be modified by Party administrators of the same Party. Only used in parties of type (Party.AccountRole) PoolManager (3) or Contractor (5).

externalId

string | null

Optional identifier linking the account to an external system. Must be unique within the same Party and limited to 50 characters.

Headers

Accept-Language

string

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

api-version

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

200OK

400Bad Request

404Not Found