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.

Create an Invitation

Create an invitation to the object specified via [id].


emails Required string The email addresses you would like to invite to the object. Multiple emails should be comma delimited in a single string.
role_name string The effective role granted to the user(s).


Returns a share object and a 201 if the call succeeds. If the role_name provided is invalid, the current default role will be used. Returns a 422 error with an error in the message body if an invalid email is provided or if a limit is reached.