Introduction

Base URL

Flinkk Mail API operates over HTTPS, adhering to REST principles. For security reasons, unencrypted HTTP connections are not permitted.

https://mail.flinkk.io

Authentication

Send a domain API key as a bearer token:

Authorization: Bearer YOUR_API_KEY

Keys are created under API Keys in the app, are shown once, and are tied to one domain. The older api-key header still works on /api/client/email/send.

Rate limits

120 requests a minute per key, and a daily sending limit per workspace. Both answer 429; the rate limit sets Retry-After.

Endpoints

• Send email: single, batch, status and idempotency keys.
• Templates: built-in and custom templates, and rendering.
• Webhooks: signed events for sent, delivered, bounced, complained, opened and clicked.
• Logs: search sent email and read each message's timeline over the API.
• Suppression list.
• Specification: OpenAPI 3.1. The agent inbox API has its own docs and spec.