Endpoints
Request and response details for the Own Auth Delivery HTTP API.
POST /v1/email
Validates and queues one auth email for the app that owns the delivery key.
To manage apps, settings, keys, and usage, use the Delivery Management API.
POST https://api.own-auth.com/v1/email
Authorization: Bearer oad_...
Content-Type: application/json
{
"to": "user@example.com",
"type": "magic_link",
"url": "https://app.example.com/auth/callback?token=abc123&redirect_url=%2Fdashboard",
"expiresAt": "2026-07-10T12:00:00.000Z"
}Email Request Fields
| Field | Required | Meaning |
|---|---|---|
| to | yes | Recipient email address. |
| type | yes | The auth email template to send. |
| url | yes | HTTPS, local development, or configured app-scheme auth URL containing one non-empty token parameter and, optionally, one redirect_url parameter generated by Own Auth. |
| expiresAt | yes | ISO timestamp for when the auth link expires. |
| organisationName | invites only | Organisation shown in an invitation email. |
| inviterName | no | Inviter shown in an invitation email. |
Email Types
| Type | |
|---|---|
magic_link | Passwordless sign in |
email_verification | Email verification |
password_reset | Password reset |
organisation_invite | Organisation invitation |
Email Success Response
HTTP/1.1 202 Accepted
Content-Type: application/json
{
"ok": true
}Email Error Responses
| Status | Meaning |
|---|---|
| 400 | Invalid body, auth URL, hosted-link configuration, or suppressed recipient. |
| 401 | Missing, invalid, or revoked delivery key. |
| 429 | Per-key, per-recipient, or daily app limit reached. |
| 503 | The delivery queue cannot accept the email. |