Skip to content

Mail

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

NameTypeRequiredDescription
namestringHuman-readable label for the key
scopestringPermission scope: 'full_access' or 'sending_access'
domainIdstringOptional Domain id this key is locked to

Response

FieldTypeAlwaysDescription
idstring
keystring
namestring
scopestring
prefixstring
domainIdstring
createdAtstring

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.

navigateselect