Send magic link email

Request

Send a magic link email for passwordless authentication. Rate limited to 3 requests per email per 10 minutes.

Security

projectKey

Bodyapplication/jsonrequired

emailstringrequired

User email address to send the magic link to

Example:"user@example.com"

redirectUrlstring

URL to redirect to after successful authentication

Example:"https://app.example.com/dashboard"

languagestring

Language code for the email template

Default:"en"

Example:"en"

paramsobject

Additional query parameters to include in the magic link URL

Example:

{
  "returnPath": "/dashboard",
  "campaign": "signup"
}

curl -i -X POST \
  https://docs.pers.ninja/_mock/swagger/auth/magic-link/send \
  -H 'Content-Type: application/json' \
  -H 'x-project-key: YOUR_API_KEY_HERE' \
  -d '{
    "email": "user@example.com",
    "redirectUrl": "https://app.example.com/dashboard",
    "language": "en",
    "params": {
      "returnPath": "/dashboard",
      "campaign": "signup"
    }
  }'

Responses

Magic link sent successfully

Bodyapplication/json

successbooleanrequired

Whether the magic link was sent successfully

Example:true

messagestring

Message describing the result

Example:"Magic link sent successfully"

errorCodestring

Error code if the request failed

Enum:"MAGIC_LINK_EMAIL_SEND_FAILED""MAGIC_LINK_EMAIL_MISMATCH""MAGIC_LINK_VERIFICATION_FAILED""INVALID_TOKEN""TOKEN_EXPIRED""INTERNAL_ERROR"

Response

{
  "success": true,
  "message": "Magic link sent successfully",
  "errorCode": "MAGIC_LINK_EMAIL_SEND_FAILED"
}