Invitations are placeholders for rolemap objects. You cannot create a rolemap directly because, sometimes, user approval is required. Invitations are sent to users via email and, once accepted, create a rolemap on the object they were invited to with the requested role.
:item
(Workspace, folder, or file) specified via :id
.workspaces
, folders
, or files
.emails
and role_name
keys described below.{"share": {"emails": "","email_errors": [],"join_errors": [],"invited_emails": [{ "first-user@example.com": 5967 },{ "second-user@example.com": 5977 }],"errors": {}}}
//
{"invitation": {"emails": "first-user@example.com, second-user@example.com","role_name": "Creator"}}
If a role_name
is not provided, or is invalid, the default role will be used.