Before you begin

# Prerequisites

Before making your first API call, there are a few platform concepts worth understanding — products, subscriptions, API keys, and optional DNS automation. This page explains each one so you know exactly what you're working with.

## Overview

Mission Inbox is organised around **products**. Each product represents a distinct set of features you can subscribe to. Your subscription gives you an **API key** scoped to that product — all API calls you make must carry that key. On top of that, you can optionally connect a **DNS provider** at the organisation level to automate domain setup entirely.

Active subscription

Required to use the API. Each product has its own subscription and API key.

Product API key

Obtained from your subscription. Passed as X-Server-API-Key header on every request.

DNS integration

Optional. Connect Cloudflare, GoDaddy, Spaceship, Porkbun, Dynadot or Vercel to automate DNS record management.

## Products

Mission Inbox sells capability bundles called **products**. Each product covers a specific use case and comes with its own isolated infrastructure — dedicated domains, mailboxes, warmup schedules, and analytics.

Currently available:

Sales & Marketing

Send transactional and outbound sales emails, manage sending domains and mailboxes, automate warmup, and monitor deliverability — all via the REST API.

Additional products may be introduced in future. Each product will have its own independent API key and subscription. Resources (domains, mailboxes) are never shared across products.

## Subscriptions

To use a product's API you must hold an active subscription for that product. Subscriptions come in two tiers:

Lite

Entry-level access with a fixed monthly send allowance. The allowance is a hard cap — sending pauses once you reach it until the next billing period or an upgrade. Suited to low volumes and to evaluating the API.

Scale

Larger included allowances with pay-as-you-go beyond them, so sending never pauses. Adds domain warmup and inbound webhooks. Built for teams running campaigns across multiple domains and mailboxes.

Included allowances and pricing are shown on your billing page — this page only covers what each tier unlocks in the API. Endpoints that need Scale are marked where they appear in the reference.

API requests made without an active subscription will be rejected with a`403 Forbidden`response. Keep your subscription current to avoid service interruption.

## Your API Key

Each active product subscription generates a unique API key scoped exclusively to that product. You'll find your key in the sidebar of this portal whenever you're logged in.

Keys follow this format:

`mi{product}_{43-character token}`

Example: `misales_4eC8vKmN2pQrStUwXyZaB6dEfGhIjLoPqRsT9uVwX1b`

Pass this key on every request using the `X-Server-API-Key` header:

`X-Server-API-Key: misales_4eC8vKmN2pQrStUwXyZaB6dEfGhIjLoPqRsT9uVwX1b`

Treat your API key like a password. Do not commit it to version control or expose it in client-side code. If compromised, contact support to have it rotated immediately.

## DNS Integration

Optional — organisation scoped

When you add a sending domain to Mission Inbox, several DNS records need to be created in your domain registrar — SPF, DKIM, DMARC, and tracking records. You can do this manually, or you can connect a DNS provider and let Mission Inbox handle it automatically.

Manual DNS

Mission Inbox provides the exact records to add. You copy them into your registrar yourself. Works with any provider. Takes a few extra minutes per domain.

Automated DNS

Recommended

Connect your Cloudflare, GoDaddy, Spaceship, Porkbun, Dynadot or Vercel account once. Mission Inbox will push all required records automatically when you add a new domain.

DNS credentials are scoped to your **organisation**, not to individual products. One connection covers all products and domains under your account. You can connect multiple key pairs per provider — useful for organisations managing domains across different accounts.

Supported providers

![Cloudflare](/src/assets/cloudflare.svg)

Cloudflare

Connect via Global API Key + account email. Supports automatic zone lookup and record upsert.

![GoDaddy](/src/assets/godaddy.svg)

GoDaddy

Connect via API key + secret. Supports automatic record creation per domain.

Spaceship

Connect via API key + secret. Supports automatic DNS record management for Spaceship-registered domains.

Porkbun

Connect via API key + secret key. Supports automatic record creation for Porkbun-registered domains.

Dynadot

Connect via API key + secret. Supports automatic record creation for Dynadot-hosted domains.

Vercel

Connect via access token (+ Team ID for team accounts). Supports automatic record creation for Vercel-managed domains.

DNS credentials are managed in your Mission Inbox dashboard under **Settings → DNS Integration**, or through the API with [DNS Provider Keys](https://doc.v4.missioninbox.com/sales/api/dns-credentials.md). This portal shows your current connection status in the header and profile menu.

## SEP Integrations

Optional — requires platform API key

Mission Inbox can connect your mailboxes directly to Sales Engagement Platforms (SEPs). Once connected, mailboxes are available in your SEP account for outbound campaigns. Provide your platform API key in the Mission Inbox dashboard under **Settings → SEP Integration**, then use the bulk connect endpoints to link mailboxes.

Supported platforms

Instantly

Connect via Instantly API key. Mailboxes are added to your Instantly workspace for campaign sending.

![SmartLead](/src/assets/smartlead.png)

SmartLead

Connect via SmartLead API key. Mailboxes are registered as sending accounts in SmartLead.

![EmailBison](/src/assets/emailbison.png)

EmailBison

Connect via EmailBison API key. Mailboxes are linked to your EmailBison account for outreach.

SEP API keys are managed in your Mission Inbox dashboard under **Settings → SEP Integration**. Each platform requires its own API key to be configured before mailboxes can be connected.

## What You See in This Portal

This documentation portal is connected to your live account. Once logged in:

Sidebar — Product & API Key

Shows your active product subscription, plan tier, and your real API key. All code examples throughout the docs automatically use your actual key.

Header — DNS Status

The globe icon shows a green dot when at least one DNS provider is connected. Hover to see all connected integrations at a glance.

Profile Menu — Organisation & DNS Keys

Click your avatar to see your organisation, connected DNS providers, and key names. Sign out from here when done.

[NextIntroduction](https://doc.v4.missioninbox.com/sales/introduction.md)
