Skip to content

invite_member

Invite a user to a workspace by email, creating the Layer user if needed.

The invited user is added with the given role (default: member) and an ACTIVE
membership; they receive an invite notification. Fails if the workspace has
invites disabled or the user is already a member. Requires workspace member-edit
permission.

Parameters

ParameterTypeDefaultDescription
workspace_idrequiredstring (uuid)The workspace to invite the user into.
emailrequiredstring (email)Email address of the person to invite. A Layer user is created if none exists.
roleenummemberWorkspace role to grant. One of: admin, settings_admin, editor, art_director, artist, member. Defaults to member (least privilege).
One of: admin, editor, settings_admin, art_director, artist, member