Skip to content

Email Member Invitation

Required scope: member:invite

The API key creator must be allowed to delegate every selected role and the optional initial team. The recipient becomes a workspace member only after a verified account with the matching email accepts the invitation. A duplicate pending invitation is rejected.

Generated Reference
POST /public-api/publicapi.v1.WorkspaceInvitation/EmailMemberInvitation

Emails a single-use workspace invitation. Duplicate pending invitations fail; this operation is not idempotent.

Request EmailMemberInvitationRequest
Response EmailMemberInvitationResponse

EmailMemberInvitationRequest

Field Type
email string
role_ids repeated string
team_id optional string

EmailMemberInvitationResponse

Field Type
invitation WorkspaceInvitation
{
"email": "invitee@example.com",
"roleIds": ["<role-id>"],
"teamId": "<team-id>"
}

This operation is not idempotent. Do not blindly retry after a timeout; inspect the workspace invitation state first.