Documents

Share a document privately

Privately shares a document owned by the authenticated user with one email address. Re-posting the same email updates its commenting permission. No invitation email is sent; the invitee gains access the next time they sign in with that email.

post/api/v1/documents/{id}/shares

Request

  • Base URL: https://mdflow.cz
  • URL: https://mdflow.cz/api/v1/documents/{id}/shares
  • Auth: HTTP bearer

Path parameters

idstring uuid required

Document UUID.

Request body

emailstring email required

Recipient email address. Trimmed and lowercased before storage.

allow_commentsboolean

Whether the recipient may comment. Defaults to false (view only).

Response

Created or updated private share.

idstring uuid required

Private share identifier. Use it to remove this person.

emailstring email required
allow_commentsboolean required

Whether the recipient may comment.

status'pending' | 'accepted' required

pending until the recipient signs in with the invited email, then accepted.

created_atstring date-time required
accepted_atstring date-time nullable required

Changes

No recorded changes to this operation across all 1 revision of this API.