/api/parties

post

https://api.facilioo.de/api/parties

Create Party

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

Module: Identity

Returns: Identity → Parties → PartyRead (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

number

string | null

type

int32

enum

required

Possible values:

1 = Admin
2 = PropertyManagementCompany
3 = PoolManager
5 = Contractor
7 = User
10 = EnergyProvider
11 = Guest
13 = InsuranceBroker
14 = Insurer
15 = Mediator

primaryName

string | null

Should be the first name (including additional first names) for natural persons, and empty for legal entities. Either PrimaryName or SecondaryName has to be set.

secondaryName

string | null

Should be the last name for natural persons, and the full name for legal entities. Either PrimaryName or SecondaryName has to be set.

ternaryName

string | null

This can be used, if the party contains more than one natural person / legal entity (in addition to PrimaryName and Secondary). It should contain the full name of the additional person as Max Mustermann.

quaternaryName

string | null

Same as TernaryName, just an additional one.

fullStreet

string | null

zipCode

string | null

city

string | null

country

string | null

description

string | null

qrCode

string | null

logoId

int32 | null

hasEmailCommunicationEnabled

boolean

required

Personal preference set by the party itself whether they want to be contacted via email.

hasMobileAppCommunicationEnabled

boolean

required

Personal preference set by the party itself whether they want to be contacted via push notifications. Can't be enabled exclusively, as either email or mail must be enabled too.

hasMailCommunicationEnabled

boolean

required

Personal preference set by the party itself whether they want to be contacted via physical mail.

website

string | null

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