Skip to content

mail_apikey_create

Issue a scoped sending API key; the full secret is returned only once

Tool

mail_apikey_create

Issue a scoped sending API key; the full secret is returned only once

Issue a scoped sending API key; the full secret is returned only once

Behavior

HTTP
POST /mail/api-keys

Arguments

Name
Type
Required
Description
name
string
•
Human-readable label for the key, e.g. "production sender"
scope
string
•
Permission scope: full_access can call every mail tool, sending_access can only send email
domainId
string
—
Lock the key to this sending domain; omit to let it send from any verified domain

Response

Field
Type
Always
Description
id
string
•
API key id; pass it to mail_apikey_delete to revoke the key
key
string
•
The full secret. Returned only by this call and never retrievable again — store it now
name
string
•
Human-readable label given when the key was issued
scope
string
•
Permission scope: full_access can call every mail tool, sending_access can only send email
prefix
string
•
Opening characters of the secret, so a key can be recognised in a log or a header
domainId
string
•
Sending domain this key is locked to; null if it may send from any verified domain
createdAt
string
•
When the key was issued (ISO 8601 UTC)

Try it

Issue a scoped sending API key; the full secret is returned only once.

When to use

Issue a scoped sending API key; the full secret is returned only once

Example

Ask your agent something like this:

Issue a scoped sending API key; the full secret is returned only once.

The agent will invoke mail_apikey_create with these arguments:

{
  "name": "<name>",
  "scope": "<scope>"
}

Esc

Start typing to search the docs.

↑↓navigate↵select