Create Party

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)

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

Identifier of the party at its property management company, which isn't necessarily unique.
Usually comes from the ERP system.
At most 45 characters.

int32
enum
required

Reference to the PartyType.
More info: Parties and Accounts

Possible values:

  • 1 = Admin
  • 2 = PropertyManagementCompany
  • 3 = PoolManager
  • 5 = Contractor
  • 7 = User
  • 10 = EnergyProvider
  • 11 = Guest
  • 13 = InsuranceBroker
  • 14 = Insurer
  • 15 = Mediator
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.

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.

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.

string | null

Same as TernaryName, just an additional one.

string | null

Street and house number of the party's address.
At most 255 characters.

string | null

Postal code of the party's address.
At most 10 characters.

string | null

City of the party's address.
At most 80 characters.

string | null

Country of the party's address, as the uppercase German country name.
It is printed as the last line of the address on letters.
At most 80 characters.

string | null

Free-text description of the party.

string | null

Content the customer app shows as a QR code to the party.
Only used for parties of type User.

int32 | null

Reference to File that represents the logo of the Party.

boolean
required

Personal preference set by the party itself whether they want to be contacted via email.
Requests by an account with the user role must keep at least one of hasEmailCommunicationEnabled and hasMailCommunicationEnabled enabled.

boolean
required

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

boolean
required

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

string | null

Website of the party.

Headers
string
Defaults to en-DE

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