sharing
Share a flow
/api/v1/flows/{entity_id}/sharing/recipients
Give a role to addresses, sharing lists or email domains.
Each recipient gets its own result: shared, invited (the address has no account yet: the invitation is recorded, and leaves with the invitations route) or refused. A domain is only accepted when it is a verified domain of the organisation the entity belongs to. notify emails the accounts shared with.
key
Required scope: share
Path parameters
-
entity_idinteger · requiredId of the binder or flow.
Request body application/json
-
recipientsarray of RecipientIn · requiredWho to share with.
2 fields
-
typestring · requiredWhat
recipientis: an address, a sharing list or a verified email domain of the organisation the entity belongs to. -
recipientstring · requiredAn address, the name of a sharing list, or a domain
-
-
rolestring · requiredThe role they all get.
-
notifyboolean · optionalEmail the accounts shared with.
-
messagestring · optionalA few words added to that email.
Response
200
RecipientsAdded
-
resultsarray of RecipientResultOne result per recipient, in the order sent.
5 fields
-
typestringAs sent.
-
recipientstringAs sent.
-
statusstringshared: done.invited: the address has no account yet, the invitation is recorded.refused: not shared,detailsays why. -
detailstringA sentence for a person.
-
notifiedboolean or nullWith
notify: whether the email left.
-
-
sharingSharingThe sharing afterwards.
4 fields
-
inheritbooleanWhether it follows the sharing of the binder that holds it instead of rules of its own.
-
reading_accessstringIts own rule:
publicopens it to anyone who has its link,limitedkeeps it to its recipients. -
effective_reading_accessstringThe rule that really applies, inheritance included.
-
recipientsarray of RecipientWho it is shared with, pending invitations included.
6 fields
-
idintegerId of the share, unique per
type: what the recipient routes take aspermission_id(orinvitation_id). -
typestringuser: an account.userslist: a sharing list.domain: every address of an email domain.invitation: an address that has no account yet. -
namestringThe address, the name of the list, or the domain.
-
permissionstringWhat the recipient may do.
-
pendingbooleantruefor an invitation not accepted yet. -
sentboolean or nullInvitations only: whether the invitation email left.
-
-
Errors
-
401
No valid credential.
-
403
The credential lacks the required scope, or the account may not do this.
-
404
Nothing with that id, or nothing the account may open.
-
409
The current state of the content forbids the request.
-
422
A value is missing or malformed.
-
429
Too many requests;
Retry-Aftergives the seconds to wait.