Skip to main content
POST
Create a scoped sending key

Authorizations

X-API-Key
string
header
default:YOUR_API_KEY
required

Dashboard API key created at https://app.wazobiamail.com/dashboard/smtp-api. Send operations also accept a narrower sending key created through POST /sending/api-keys; every other operation needs the dashboard key.

Body

application/json
name
string
required
Required string length: 2 - 120
Example:

"Billing worker"

scope
enum<string>
default:general

general selects from account mailboxes; domain restricts selection to one verified domain and requires an active or trialing Business or Enterprise subscription.

Available options:
general,
domain
domainId
string

Required when scope is domain. Use the id of a verified sending domain.

expiresAt
string

Optional expiry timestamp. Expired keys return 401.

Example:

"2027-01-31T23:59:59"

Response

Key created. data.apiKey contains the secret once, plus id, name, scope, domainId, keyPrefix and expiresAt.

success
boolean
required
Example:

true

message
string
required
Example:

"Done"

data
any
required

Payload; shape depends on the endpoint.