LIlium
Workspaces

Invite an e-mail address

Changed on

Owners and admins invite one address (it need not have a Lium account yet) with a role; admins cannot grant owner. The address receives a link that is valid for seven days; a verified session on that address opens it and joins. 422 for anything but one plain address; 409 when the address is already a member or already invited, or the workspace holds 50 open invitations; 30/minute per client. email_sent false means the mail did not leave: revoke and invite again.

post/workspaces/{workspace_id}/invitations

Request

  • Base URL
    https://lium.io/api
  • URL
    https://lium.io/api/workspaces/{workspace_id}/invitations
  • Auth
    HTTP bearer

Path parameters

workspace_idstring uuid required

Request body

emailstring email required

Where the invitation is sent: exactly one address, lower-cased; it need not have a Lium account yet. 422 for anything that is not one plain address.

role'owner' | 'admin' | 'member'

Admins may grant admin or member; owners any role.

Response

Successful Response

idstring uuid required
workspace_idstring uuid required
emailstring required
role'owner' | 'admin' | 'member' required
invited_by_user_idstring uuid required
status'pending' | 'accepted' | 'revoked' | 'expired' required
expires_atstring date-time required
created_atstring date-time required
email_sentboolean nullable

On creation only: whether the e-mail left. False means revoke and invite again.

Changes