sharing
Change the sharing rules of a flow
/api/v1/flows/{entity_id}/sharing
reading_access: public opens the content to anyone who has its link, limited keeps it to its recipients. inherit: true makes it follow the sharing of the binder that holds it.
key
Required scope: share
Path parameters
-
entity_idinteger · requiredId of the binder or flow.
Request body application/json
-
inheritboolean or null · optionaltrueto follow the sharing of the binder that holds it,falseto give it rules of its own. -
reading_accessstring or null · optionalpublicopens it to anyone who has its link,limitedkeeps it to its recipients.
Response
200
Sharing
-
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.