# FranklyMail API

**Canonical:** https://apis.io/apis/franklymail-com/franklymail-com-api/  
**Provider:** FranklyMail — https://apis.io/providers/franklymail-com/  
**Documentation:** https://franklymail.com/docs/api

FranklyMail API is one of 2 APIs that [FranklyMail](https://apis.io/providers/franklymail-com/) publishes on the [APIs.io](https://apis.io/) network, described by a machine-readable OpenAPI specification. This API exposes 6 JSON Schema definitions. The published artifact set on APIs.io includes an OpenAPI specification and 6 JSON Schemas.

FranklyMail API as documented publicly: 38 operations. Contract generated from the documentation by API Evangelist (2026-11-09); not the provider's own document.

## Operations (38)

| Method | Path | Summary |
|---|---|---|
| GET | `/aliases` | GET /aliases Every alias, optionally filtered by ?domainId=. |
| POST | `/aliases` | POST /aliases Create one. |
| DELETE | `/aliases/{id}` | DELETE /aliases/:id Remove it. |
| PATCH | `/aliases/{id}` | PATCH /aliases/:id Change its destination. |
| POST | `/api/domains` | POST /api/domains Hinzufügen einer Domain. |
| POST | `/api/mailboxes` | POST /api/mailboxes |
| GET | `/api/mailboxes/{mailboxid}` | GET /api/mailboxes/{mailboxid} |
| POST | `/api/mailboxes/{mailboxid}` | POST /api/mailboxes/{mailboxid} |
| POST | `/api/v1/drafts` | Create a draft. |
| GET | `/api/v1/drafts/{id}` | Get a draft. |
| PUT | `/api/v1/drafts/{id}` | Update a draft. |
| GET | `/api/v1/mailboxes/{id}/messages` | Equivalent HTTP route to list messages. |
| GET | `/api/v1/mailboxes/{id}/messages/{messageid}` | Equivalent HTTP route to read a message. |
| POST | `/api/v1/mailboxes/{id}/messages/{messageid}/move` | Additional OAuth HTTP route to move a message. |
| GET | `/api/v1/mailboxes/{id}/sender-identities` | Additional OAuth HTTP route to list sender identities. |
| GET | `/domains` | Every domain on the account, each with its DNS check result. |
| POST | `/domains` | Add a domain. |
| DELETE | `/domains/{id}` | Remove a domain. |
| POST | `/domains/{id}/dkim/rotate` | Begin a DKIM key rotation. |
| POST | `/domains/{id}/recheck` | Re-resolve now, rather than waiting for the schedule. |
| GET | `/domains/{id}/records` | The expected records and what DNS currently answers. |
| GET | `/mailboxes` | Every mailbox, with its address, quota and provisioning state. |
| POST | `/mailboxes` | Create one. |
| DELETE | `/mailboxes/{id}` | DELETE /mailboxes/:id Delete the mailbox. |
| PATCH | `/mailboxes/{id}` | Change the display name or quota. |
| GET | `/mailboxes/{id}/export` | GET /mailboxes/:id/export answers 403 browser_only to a key. |
| GET | `/mailboxes/{id}/import` | GET /mailboxes/:id/import Progress of the latest import for this mailbox. |
| POST | `/mailboxes/{id}/import` | POST /mailboxes/:id/import Start an IMAP import. |
| POST | `/mailboxes/{id}/import/cancel` | POST /mailboxes/:id/import/cancel Stop the running import. |
| POST | `/mailboxes/{id}/password` | Set a new password for the mailbox. |
| GET | `/mailboxes/{id}/sieve` | The mailbox filter script. |
| PUT | `/mailboxes/{id}/sieve` | Replace it. |
| POST | `/sieve/validate` | POST /sieve/validate checks a script first. |
| GET | `/v1/domains` | Selected domain metadata. |
| GET | `/v1/domains/{id}` | One selected domain. |
| GET | `/v1/domains/{id}/dns` | Stored DNS observations. |
| GET | `/v1/mailboxes` | Selected mailbox metadata, without messages. |
| GET | `/v1/mailboxes/{id}` | One selected mailbox, without secrets. |

## Machine-readable artifacts (7)

- **OpenAPI** — https://artifacts.apis.io/franklymail-com/openapi/_ae-authored/franklymail-com-openapi-generated.yml
- **JSONSchema** — https://artifacts.apis.io/franklymail-com/json-schema/franklymail-com-post-api-v1-drafts-request-schema.json
- **JSONSchema** — https://artifacts.apis.io/franklymail-com/json-schema/franklymail-com-post-mailboxes-request-schema.json
- **JSONSchema** — https://artifacts.apis.io/franklymail-com/json-schema/franklymail-com-post-mailboxes-id-import-request-schema.json
- **JSONSchema** — https://artifacts.apis.io/franklymail-com/json-schema/franklymail-com-post-aliases-request-schema.json
- **JSONSchema** — https://artifacts.apis.io/franklymail-com/json-schema/franklymail-com-post-api-v1-mailboxes-id-messages-messageid-move-request-schema.json
- **JSONSchema** — https://artifacts.apis.io/franklymail-com/json-schema/franklymail-com-post-api-mailboxes-mailboxid-request-schema.json

## Other FranklyMail APIs (1)

- [FranklyMail API](https://apis.io/apis/franklymail-com/franklymail-api/)

---

Profiled by [API Evangelist](https://apievangelist.com) and published on [APIs.io](https://apis.io/apis/franklymail-com/franklymail-com-api/). The API's provider profile, Kin Score and agent-readiness rating are at https://apis.io/providers/franklymail-com/.