Send a test email

Send one transactional email to your own address.

POST /organizations/{org}/emails/{template}/test

Sends the template, wearing its assigned kit, to the address on your own account. 202 means the email provider accepted it.

Authorization

Any member of the org. A non-member gets 404, the same as for an org that does not exist.

Path parameters

NameTypeDescription
orgstringThe organization: its id (org_…) or its slug. It has to be an org your token can manage (see Who can call it)
templatestringinvite, magic-link, email-code, new-sign-in or password-reset

No body.

Response

202 Accepted

{ "status": "sent" }

Errors

StatuserrorWhen
404not_foundUnknown template, or the org is not yours
409conflictThe org has no brand kit yet
422unprocessableYour account has no email address
502bad_gatewayThe email provider refused the send
503unavailableTransactional email is not configured

Example

curl -X POST https://loginwith.loginwith.dev/organizations/acme/emails/magic-link/test \
  -H "Authorization: Bearer $TOKEN"