MultiMail Account API
The Account API from MultiMail — 4 operation(s) for account.
The Account API from MultiMail — 4 operation(s) for account.
Every API here is available over the APIs.io API and to AI agents over MCP.
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.curl "https://apis.io/api/v1/apis/multimail-dev:multimail-dev-account-api"
curl "https://apis.io/api/v1/apis?limit=25"
Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. By signing up you are subscribing to the APIs.io and API Evangelist newsletters — you can unsubscribe from any issue. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
openapi: 3.2.0
info:
title: MultiMail Account API
version: 2.0.0
description: Email-as-a-Service for AI agents. Inbound email converted to markdown, outbound markdown converted to HTML. Built on Cloudflare Workers.
servers:
- url: https://api.multimail.dev
tags:
- name: Account
paths:
/v1/account/challenge:
post:
summary: Request proof-of-work challenge for signup
description: Returns an ALTCHA challenge. Solve it and include the solution as pow_solution in POST /v1/account. Challenge expires in 5 minutes.
requestBody:
content:
application/json:
schema:
type: object
properties:
oversight_email:
type: string
format: email
description: Optional. Calibrates difficulty based on email domain.
attribution:
$ref: '#/components/schemas/AttributionPayload'
description: Optional conversion attribution. Same bounded payload accepted by signup; used only for source-keyed funnel challenge counts.
responses:
'200':
description: Challenge issued
content:
application/json:
schema:
type: object
properties:
algorithm:
type: string
example: SHA-256
challenge:
type: string
maxnumber:
type: integer
salt:
type: string
signature:
type: string
tags:
- Account
operationId: postV1AccountChallenge
x-operation-id-source: derived
/v1/account/did-challenge:
post:
summary: Issue an account-binding DID challenge
description: DID bridge (optional). POST agent_did (an Ed25519 did:key) and receive {challenge_id, nonce}. Sign the UTF-8 of MM-DID-BIND:v1\n\n\n\ndid:web:multimail.dev (single LF joins, no trailing newline) with the DID's Ed25519 key, then pass agent_did + did_challenge_id + did_signature to POST /v1/account. Single-use; expires in 5 minutes. No auth required.
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- agent_did
properties:
agent_did:
type: string
maxLength: 256
description: did:key:z… encoding an Ed25519 public key.
responses:
'200':
description: Challenge issued
content:
application/json:
schema:
type: object
properties:
challenge_id:
type: string
maxLength: 64
nonce:
type: string
maxLength: 64
expires_in:
type: integer
'400':
description: agent_did missing or not a valid Ed25519 did:key
'429':
description: Rate limited (shared per-IP challenge budget)
tags:
- Account
operationId: postV1AccountDidChallenge
x-operation-id-source: derived
/v1/account:
post:
summary: Create a new account (deferred provisioning)
description: Requires a solved proof-of-work challenge. Creates a pending signup and sends a confirmation email. Response is always identical for privacy (anti-enumeration). Honors an optional Idempotency-Key request header (UUID) to safely retry without creating duplicate pending_signups rows.
parameters:
- name: Idempotency-Key
in: header
required: false
schema:
type: string
maxLength: 200
description: Client-generated UUID. Replays return the cached response (1hr TTL). In-flight retries return 409.
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/SignupRequest'
responses:
'200':
description: Confirmation sent (privacy-preserving — does not confirm account creation)
content:
application/json:
schema:
$ref: '#/components/schemas/SignupResponse'
'409':
description: Concurrent request with same Idempotency-Key in flight.
tags:
- Account
operationId: postV1Account
x-operation-id-source: derived
get:
summary: Get current tenant info and usage
description: Requires read scope.
security:
- bearerAuth: []
responses:
'200':
description: Tenant info
content:
application/json:
schema:
$ref: '#/components/schemas/AccountInfo'
tags:
- Account
operationId: getV1Account
x-operation-id-source: derived
patch:
parameters:
- name: X-MultiMail-Approval-Code
in: header
required: false
schema:
type: string
description: Operator-delivered single-use proof for the exact request. Without proof, HTTP 202 requests operator approval and does not complete the operation. Confirmation booleans and MCP UI hints cannot grant authority.
summary: Update tenant settings
description: Requires admin scope. Sensitive changes require a request-bound operator code; API-key scope alone does not authorize them.
security:
- bearerAuth: []
requestBody:
content:
application/json:
schema:
type: object
properties:
name:
type: string
maxLength: 200
oversight_email:
type: string
format: email
maxLength: 320
physical_address:
type: string
maxLength: 2000
approval_code:
type: string
maxLength: 16
responses:
'200':
description: Settings updated
'202':
description: Operator approval requested; operation not completed
tags:
- Account
operationId: patchV1Account
x-operation-id-source: derived
delete:
summary: Permanently delete tenant account
description: Hard-deletes all tenant data (mailboxes, emails, API keys, usage, audit log). Frees the slug for re-registration. Requires admin scope.
security:
- bearerAuth: []
requestBody:
content:
application/json:
schema:
type: object
properties:
approval_code:
type: string
maxLength: 16
responses:
'200':
description: Account deleted
content:
application/json:
schema:
type: object
properties:
status:
type: string
example: deleted
'401':
description: Missing or invalid API key
'403':
description: Requires admin scope
tags:
- Account
operationId: deleteV1Account
x-operation-id-source: derived
/v1/account/resend-confirmation:
post:
summary: Resend operator confirmation email
description: Public endpoint (no auth required). Resends the activation email with a new code for unconfirmed accounts. Rate limited to 1 request per 10 minutes per email. Response is identical whether or not a pending signup exists (anti-enumeration).
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- oversight_email
properties:
oversight_email:
type: string
format: email
maxLength: 320
description: The oversight email used at signup.
responses:
'200':
description: Confirmation resent (privacy-preserving — returned even if no pending signup exists)
content:
application/json:
schema:
type: object
properties:
status:
type: string
example: confirmation_resent
message:
type: string
'400':
description: oversight_email missing
'429':
description: Rate limited — wait 10 minutes
'503':
description: Confirmation email could not be delivered — previously emailed code stays valid; cooldown is cleared so an immediate retry is allowed
tags:
- Account
operationId: postV1AccountResendConfirmation
x-operation-id-source: derived
components:
schemas:
SignupRequest:
type: object
required:
- operator_name
- accepted_tos
- accepted_operator_agreement
- accepted_anti_spam_policy
- oversight_email
- pow_solution
properties:
operator_name:
type: string
description: Company or individual name. Included in identity headers and signature block.
payment_method:
type: string
enum:
- stripe
- crypto
description: Signup intent source. Pricing page starter flow sends stripe.
accepted_tos:
type: boolean
description: Must be true.
accepted_operator_agreement:
type: boolean
description: Must be true.
accepted_anti_spam_policy:
type: boolean
description: Must be true.
email_use_type:
type: string
enum:
- transactional
- marketing
description: Only transactional is accepted today.
oversight_email:
type: string
format: email
slug:
type: string
description: URL-safe slug. Auto-generated from operator_name if omitted.
physical_address:
type: string
use_case:
type: string
oversight_mode:
type: string
enum:
- gated_all
- gated_send
- monitored
description: Optional initial mailbox oversight mode. Unsafe modes are rejected.
cf_challenge_response:
type: string
maxLength: 4096
description: 'Preferred browser Turnstile token field. Mirrors the hidden cf-turnstile-response input value. maxLength keeps API Shield''s auto-learned body-size cap above the ~1.6KB Turnstile token (see lesson #18).'
turnstile_token:
type: string
maxLength: 4096
deprecated: true
description: 'Legacy Turnstile token field. Accepted for backward compatibility. maxLength matches cf_challenge_response — see lesson #18.'
fingerprint:
type: string
maxLength: 256
description: Optional browser fingerprint used for signup throttling.
form_open_at:
type: integer
format: int64
description: Epoch milliseconds when the signup modal opened.
pow_solution:
type: object
required:
- algorithm
- challenge
- number
- salt
- signature
description: Solved ALTCHA proof-of-work challenge from POST /v1/account/challenge.
properties:
algorithm:
type: string
example: SHA-256
challenge:
type: string
description: Challenge hash from the challenge endpoint
number:
type: integer
description: Solved number N where SHA-256(salt + N) matches challenge
salt:
type: string
description: Salt from the challenge (echo back unchanged)
signature:
type: string
description: Signature from the challenge (echo back unchanged)
attribution:
$ref: '#/components/schemas/AttributionPayload'
agent_did:
type: string
maxLength: 256
description: Optional Ed25519 did:key to bind to this account (DID bridge). Provide with did_challenge_id + did_signature; all three together or none.
did_challenge_id:
type: string
maxLength: 64
description: Opaque challenge_id from POST /v1/account/did-challenge.
did_signature:
type: string
maxLength: 96
description: 'base64url Ed25519 signature over the account-bound binding payload (64 raw bytes → ≤88 base64url chars; maxLength 96 keeps the API-Shield body cap above it — lesson #18).'
AttributionVisit:
type: object
description: A single landing event — first or last touch.
additionalProperties: false
properties:
ts:
type: integer
format: int64
description: Epoch milliseconds at landing.
landing_path:
type: string
maxLength: 256
description: Pathname of the landing page (no host).
params:
type: object
description: Tracked URL params present on the landing page. All keys optional; unknown keys are dropped server-side. additionalProperties:false enforces the allowlist at the schema layer too (adversary review iter1 ATTR-1).
additionalProperties: false
properties:
utm_source:
type: string
maxLength: 256
utm_medium:
type: string
maxLength: 256
utm_campaign:
type: string
maxLength: 256
utm_content:
type: string
maxLength: 256
utm_term:
type: string
maxLength: 256
gclid:
type: string
maxLength: 256
fbclid:
type: string
maxLength: 256
msclkid:
type: string
maxLength: 256
AccountInfo:
type: object
properties:
id:
type: string
name:
type: string
slug:
type: string
plan:
type: string
enum:
- starter
- builder
- pro
- scale
billing_management:
type: string
enum:
- stripe
- checkout
- support
description: Non-secret billing capability. Stripe portal, first-subscription checkout, or support-assisted changes; do not infer provider from plan name.
oversight_email:
type: string
format: email
physical_address:
type:
- string
- 'null'
monthly_email_quota:
type: integer
emails_sent_this_month:
type: integer
max_mailboxes:
type: integer
storage_used_bytes:
type: integer
max_storage_bytes:
type: integer
is_active:
type: boolean
sending_disabled:
type: boolean
sending_disabled_reason:
type:
- string
- 'null'
SignupResponse:
type: object
description: Always returns the same response for privacy (anti-enumeration). Does not confirm whether the account was actually created.
properties:
status:
type: string
example: confirmation_sent
message:
type: string
example: Check your email for the activation code.
AttributionPayload:
type: object
description: 'Optional client-captured conversion attribution (Phase 2 of plan 2026-04-27-003). The browser persists this in localStorage.mm_attribution_v1 and forwards it on signup. Server-side validator at src/lib/attribution.ts is the source of truth — bad shapes are silently dropped, NEVER reject the signup. additionalProperties:false on this object AND its sub-objects keeps the API Shield body-size cap honest even if the per-operation mitigation pin in scripts/sync-api-shield.sh is ever undone: an attacker cannot pad the body with arbitrary unknown keys to bypass the per-field maxLengths (adversary review iter1 finding ATTR-1).'
additionalProperties: false
properties:
first:
$ref: '#/components/schemas/AttributionVisit'
last:
$ref: '#/components/schemas/AttributionVisit'
visits:
type: integer
format: int32
minimum: 1
maximum: 1000000
description: Visit counter, incremented client-side. Server validator coerces missing/zero/negative values to 1.
version:
type: integer
format: int32
enum:
- 1
description: Schema version. Only 1 is currently accepted; future bumps will rotate the localStorage key client-side and add new branches server-side.
securitySchemes:
bearerAuth:
type: http
scheme: bearer
description: 'API key (mm_live_...). Keys have scopes: read (list/read emails, mailboxes, contacts), send (send/reply/cancel emails), admin (manage mailboxes, API keys, billing, account), oversight (approve/reject pending emails).'