Send invite email

POSThttps://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.

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]

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
curl --request POST \
  --url https://test.stytch.com/v1/b2b/magic_links/email/invite \
  -u 'PROJECT_ID:SECRET' \
  -H 'Content-Type: application/json' \
  -H "X-Stytch-Member-Session: mZAYn5aLEqKUlZ_Ad9U_fWr38GaAQ1oFAhT8ds245v7Q" \
  -d '{
    "organization_id": "organization-test-07971b06-ac8b-4cdb-9c15-63b17e653931",
    "email_address": "sandbox@stytch.com"
  }'

RESPONSE

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

Common Error Types