Skip to main content
POST
Send a magic link

Authorizations

x-portal-auth-environment-id
string
header
required

The Auth Environment ID for the environment you are authenticating against. Find it in the Portal dashboard under Authentication > Configure.

Body

application/json
email
string<email>
required

The end user's email address. Must be lowercase. Addresses containing uppercase characters are rejected with 400.

redirectUrl
string<uri>
required

Where the magic link sends the user. Must exactly match one of the environment's Redirect URLs. Matching is exact string equality, so wildcards and path prefixes are not supported.

fromEmail
string<email>
required

The address the email is sent from. Must belong to a verified sending domain that is enabled for this environment.

templateId
string
required

The Portal template ID from Authentication > Templates in the dashboard.

Response

Magic link sent successfully

data
object
metadata
object | null

Always null for this endpoint.