Create Document Share

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 Account Permission: UploadDocument (32)

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

Grant of one document to one party, which gives that party access to the document.
While the document's group is configured for at least one contract type, the next run of automatic sharing deletes a share created by hand unless it would create the same share itself.
More info: Documents

int32
required

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

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.

boolean
required

Whether the receiving party has opened the document.
The receiving party can only set it to true.

boolean
required

Whether the document was sent to the receiving party (e.g. by email, push notification or letter).
Set when facilioo sends the notification for the share, or toggled by hand by the sender; it has no effect on access.
The receiving party cannot change it.

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