inviteMember.md

//////////////////////////////////////////////////////////////////////////////////////////////
// DO NOT MODIFY THIS FILE                                                                  //
// This file is automatically generated by ZenStack CLI and should not be manually updated. //
// Source: schema.zmodel · Generated: 2026-02-23                                            //
//////////////////////////////////////////////////////////////////////////////////////////////

Index / Procedures / inviteMember

inviteMember Mutation

Invite a new member to a workspace.

Sends an invitation email to the specified address. If the user already has an account, the invitation is linked immediately. Otherwise, a pending membership is created and fulfilled when the user signs up.

Only workspace OWNERs and ADMINs can invite new members. The invited user's role cannot exceed the inviter's role (e.g. an ADMIN cannot invite an OWNER).

Defined in: procedures.zmodel

Declaration · procedures.zmodel

mutation procedure inviteMember(
    workspaceId: String,
    email: String,
    role: WorkspaceRole?
): WorkspaceMember

📥 Parameters

Input parameters accepted by this procedure.

Parameter	Type	Required
workspaceId	String	Yes
email	String	Yes
role	WorkspaceRole	No

📤 Returns

The return type of this procedure.

WorkspaceMember

---

📚 References

• ZModel procedures — ZenStack documentation

---

Previous: getWorkspaceAnalytics · Next: publishArticle