api.orgs.members.invite
Invite a user by email. Admin/owner only. The invitee must explicitly accept before membership exists. The returned row is in pending shape (user_id: null, invitation_id: <uuid>) until they accept via POST /users/me/invitations/{id}/accept.
Seismic sends the invitee a notification email with a link to accept. Delivery is best-effort. If the email is lost, an admin can re-trigger it with api.orgs.invitations.resend(invitationId).
const = await ...({
: "carol@acme.com",
: "member",
});| Argument | Type | Notes |
|---|---|---|
req | { email: string; role?: "admin" | "member" | "viewer" } | Defaults to "member". Cannot invite as "owner". Promote via updateRole instead. Admins can only invite as "member" or "viewer". |
Returns: Promise<OrgMembership>.
Throws: ApiError 400 (bad email/role), 403 (not allowed at this role), 409 (already a member).
REST endpoint: POST /org/members.