API Keys

Authenticate the API with scoped, least-privilege keys.

API keys authenticate requests to the public v1 API, the SDKs, the CLI and the SMTP relay. Create one under API Keys (also in Settings → Developers), pick what it may do, and copy the secret: it's shown once.

Scopes

Every key has a scope. Full access can use every API operation except the opt-in ones, which you tick under Advanced: branding:write (branding, the logo, the workspace's name and image, Brand Kits), apikeys:read (your keys and their usage) and activity:read (the activity log). Sending can send email, campaigns and SMS, and read what a sender needs (contacts, templates, domains, sends). Read only can read everything except the opt-in reads, and change nothing. What each one covers:

AreaFull accessSendingRead only
EmailsRead and sendRead and sendRead
SMSRead, manage and sendRead and sendRead
CampaignsRead, manage and sendRead and sendRead
TemplatesRead and manageReadRead
ContactsRead and manageReadRead
SegmentsRead and manageReadRead
TopicsRead and manageReadRead
DomainsRead and manageReadRead
WebhooksRead and manage—Read

On a paid plan you can also pick the exact capabilities a key holds instead of a preset (Advanced, when you create it). The API checks the key's capabilities on every request and answers 403 with the missing permission's name when one is missing.

What no key can do

No key, not even Full access, can manage API keys, the team or billing, delete the workspace, or buy SMS numbers and registrations. Those stay in the dashboard behind a signed-in person, so a leaked key can never widen its own access. Changing branding, Brand Kits and the workspace's name is open to a key only when you tick branding:write on it (MCP's older brand_kits_import also takes templates:write).

Plans

FreeStarterGrowth
Active keys31050
Full access and SendingYesYesYes
Read only and custom capabilities—YesYes

Rotate and revoke

A key's scope can't be changed after it's created. To change what an integration can do, create a new key, deploy it, then revoke the old one. Revoking is immediate: the next request with that key gets 401. The SMTP relay's credential is a Sending key, so the same rules apply.

Scope tightly

Give each integration the least it needs: a server that only sends mail gets a Sending key, a reporting job gets Read only. Keys belong to the workspace, and anyone who can manage API keys can see and revoke them.

Pair keys with Webhooks for a full integration: keys for your calls to Unitpost, webhooks for Unitpost's events back to you. People's access is separate: see Team.

Search docs and guides

Search the docs and product guides.