/api/document-shares

post

https://api.facilioo.de/api/document-shares

Create Document Share

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

Module: Documents

Returns: Documents → Documents → Shares → DocumentShareRead (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

documentId

int32

required

Identifier of the shared document. Can only be set during creation. A document can only be shared once per party.

partyId

int32

required

Identifier of the party receiving access to the document. Can only be set during creation. A document can only be shared once per party.

wasRead

boolean

required

Indicates whether the receiving party has read or acknowledged the document.

wasSent

boolean

required

Indicates whether a notification about the document share has been sent (e.g. email, push notification or letter).

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

Language

Credentials

Bearer

JWT

URL

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200OK

400Bad Request

404Not Found