Send Invite Email

Send invite email

POST

https://test.stytch.com/v1/b2b/magic_links/email/invite

Send an invite email to a new Member to join an Organization. The Member will be created with an invited status until they successfully authenticate. Sending invites to pending Members will update their status to invited. Sending invites to already active Members will return an error.

The magic link invite will be valid for 1 week.

Revoke an invite

To revoke an existing invite, use the Delete Member endpoint. This will both delete the invited Member from the target Organization and revoke all existing invite emails.

RBAC Enforced API

When a Member Session is passed in the Authorization headers, Stytch will enforce that the Member has permission to take the create Action on the stytch.member Resource prior to honoring the request.

To learn more, see our RBAC guide.

Body parameters

organization_id* string

email_address* string

invite_redirect_url string

invite_template_id string

invited_by_member_id string

name string

trusted_metadata object

untrusted_metadata object

locale string

roles array[strings]

invite_expiration_minutes int

Header parameters

X-Stytch-Member-Session string

X-Stytch-Member-SessionJWT string

Response fields

request_id string

status_code int

member_id string

member object

organization object

const stytch = require('stytch');

const client = new stytch.B2BClient({
  project_id: 'PROJECT_ID',
  secret: 'SECRET',
});

const params = {
  organization_id: "organization-test-07971b06-ac8b-4cdb-9c15-63b17e653931",
  email_address: "sandbox@stytch.com",
};

const options = {
  authorization: {
    session_token: 'mZAYn5aLEqKUlZ_Ad9U_fWr38GaAQ1oFAhT8ds245v7Q',
  },
};

client.magicLinks.email.invite(params, options)
  .then(resp => { console.log(resp) })
  .catch(err => { console.log(err) });

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": {...}
}

Delete

Organization

Discovery

Organization

Discovery

Discovery

Organization

Token

SAML

OIDC

External

Shared

Connection management

Token management

SCIM groups

Reset Options

One-time passcodes

Time-based one-time passcodes

Recovery codes

TOKEN

M2M Client

Rotate secret

Tokens

Configuration

Methods

Revoke an invite

Body parameters

Header parameters

Response fields

Common Error Types