Create an API key

POSThttps://api.mailfully.com/v1/api-keys

Mint a new API key. The full plaintext key is returned once, only here. Scopes default to ["send"] and may only include the mintable scopes send, read:emails, read:inbound, read:analytics, read:suppressions, manage:webhooks, and manage:suppressions. manage:keys can never be minted onto a key. manage:webhooks and manage:suppressions are allowed on live keys only: webhooks and suppressions are shared by both environments, so a test key holding them would reach live data. Creating a test key with either returns 422 validation_error with param scopes. The environment is taken from the session, never the body. Dashboard only (owner or admin). API keys get 403 insufficient_scope.

Loading code example

Loading code example

Authorizations

Authorizationstringheaderrequired

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

namestringrequired

Length: >= 1

Defaults to ["send"] when omitted. Only mintable scopes are allowed. manage:webhooks and manage:suppressions are for live keys only.

Required array length: >= 1 elements

domain_idstring

Optional domain (dom_…) the key is restricted to; must be owned by the organization.

Response

application/json

The API key was created; the plaintext is shown once.

object"api_key"required

Allowed values: "api_key"

idstringrequired

namestringrequired

keystringrequired

The full plaintext secret; returned only at creation and rotation, never again.

prefixstringrequired

last4stringrequired

environment"live" | "test"required

Allowed values: "live" | "test"

created_atstring<date-time>required