Stytch - Auth platform for developers

B2B Saas Authentication

Frontend SDKs

Headless

Email Magic Links

Invite

The invite method wraps the invite Email Magic Link API endpoint. The organization_id will be automatically inferred from the logged-in Member's session.

Authenticated Method

This method requires valid Session for a Member with permission to perform the create Action on the stytch.member Resource.

Before using this method, enable Member actions & permissions in the SDK Configuration page. To learn more, see our RBAC guide.

Method parameters

email_address* string

invite_redirect_url string

invite_template_id string

name string

roles array[strings]

untrusted_metadata object

locale string

Response fields

request_id string

status_code int

member_id string

member object

organization object

import { useStytchB2BClient } from '@stytch/react/b2b';

export const InviteMember = () => {
  const stytch = useStytchB2BClient();

  const inviteMember = () => {
    stytch.magicLinks.email.invite({
      email_address: 'sandbox@stytch.com',
    });
  };

  return <button onClick={inviteMember}>Invite a Member</button>;
};

RESPONSE

{
    "status_code": 200,
    "request_id": "request-id-test-b05c992f-ebdc-489d-a754-c7e70ba13141",
    "member_id": "member-test-32fc5024-9c09-4da3-bd2e-c9ce4da9375f",
    "member": {...},
    "organization": {...}
}