/api/processes

post

https://api.facilioo.de/api/processes

Create Proces

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

Module: Processes

Returns: Processes → Processes → ProcessRead (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

accountId

int32 | null

The ID of the account creating the process. If omitted, the account is derived from the authenticated user.

subject

string | null

A short, descriptive title summarizing the process context.

Visibility of the subject may depend on party-specific settings. For example, property management companies can configure whether the subject is shown or hidden in the user interface.

report

string

required

length ≥ 1

A rich-text (HTML-enabled) description providing detailed information about the process context.

contactId

int32

required

The party acting as the primary contact for this process.

typeId

int32

required

The ID of the ProcessType defining the classification of the process.

stageId

int32 | null

The initial or updated ProcessStage of the process.

isFinished

boolean | null

Defaults to false

Indicates whether the process should be marked as finished.

finishDate

date-time | null

The date and time when the process was finished. This value must be set explicitly and is not automatically derived from IsFinished.

unitId

int32

required

The unit this process is associated with.

externalId

string | null

External identifier used when synchronizing this process with a third-party system.

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