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 (or the workspace's default) 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.
roleenum—Workspace role to grant: admin or creator, plus member in an enterprise workspace. Leave unset for the workspace's default: creator, or member in an enterprise workspace.
One of: admin, editor, settings_admin, art_director, artist, creator, member, installation, provisioning