Skip to contentSkip to navigation

API Reference

The public delivery endpoint accepts authenticated email delivery requests.

POST /v1/email

Own Auth calls this endpoint through OwnAuthManagedEmailProvider. Apps normally do not call it by hand.

http
POST /v1/email
Authorization: Bearer oad_live_...
Content-Type: application/json

{
  "to": "user@example.com",
  "type": "magic_link",
  "url": "https://your-app.com/auth/callback?token=...",
  "expiresAt": "2026-07-09T12:00:00.000Z"
}
json
{
  "ok": true
}

Request Fields

FieldRequiredMeaning
toyesRecipient email address.
typeyesEmail type.
urlyesAuth URL created by Own Auth. It may use HTTPS, localhost or 127.0.0.1 for local development, or a configured app scheme. It must include only a non-empty token query parameter.
expiresAtyesISO timestamp for when the auth link expires.
organisationName / org_namenoOrganisation name for invite emails.
inviterName / inviter_namenoInviter display name or email for invite emails.

Response Codes

CodeMeaning
202Request queued.
400Invalid request body or URL.
401Missing or invalid delivery key.
403URL is not allowed for the app.
429Rate limit or daily limit reached.