30 days free. No credit card. Full access from the moment you connect your site.

Start free trial

MailerPress Manage API Keys

mailerpress/manage-api-keys handles MailerPress API-key lifecycle through one surface: list, create, update, revoke, reactivate and delete.

These are integration API keys for MailerPress’s own admin API — distinct from the Pro embed keys, which are a different thing for a different purpose.

Before you run it

The raw key is returned once, on creation, and MailerPress cannot re-issue it — a response not captured means the key is unusable. The delete operation is a hard delete requiring confirm_id; revoke is the soft version that marks a key inactive and can be reversed with reactivate.

At a glance

Abilitymailerpress/manage-api-keys
ToolsetMailerPress — toolset/mailerpress
GroupMailerPress › Settings & Delivery
RequiresAcrossAI Pro, plus MailerPress active on the site
Capabilitymanage_options
SafetyDestructive in its delete operation — requires confirm_id. The raw key is returned once on creation and never again.
RepeatableNot idempotent — each call changes the row set, so re-running is not a no-op
Ships inAcrossAI Pro 0.9.16 and later

How it works

Creation returns metadata plus the raw key, and that is the only moment the key exists in readable form. It is stored one-way afterwards, so a response that is not captured leaves a key nobody can use and which still appears in the listing.

Revoke and delete are deliberately different. Revoking marks a key inactive, which stops it working and keeps the record — reversible with reactivate, and the right response to a key you suspect rather than know about.

Deleting is hard and permanent, and requires confirm_id matching the key’s ID.

Revoking first is the safer sequence: stop the key, see what breaks, and delete once you know what used it.

These keys grant access to MailerPress’s admin API, which reaches contacts and campaigns. A leaked key is a contact-data exposure rather than an inconvenience.

Not idempotent for create and delete.

Input

NameTypeRequiredWhat it is
actionstringYeslist, create, update, revoke, reactivate or delete.
idintegerFor all but list and createThe key.
confirm_idintegerFor deleteMust match id.
namestringFor create and updateWhat the key is for.
confirmbooleanYes — must be trueThe irreversibility gate. Without it the call is refused before anything is touched.

What comes back

NameTypeWhat it is
keystringThe raw key — on creation only, and never again.
keysarrayThe key metadata, for list.
successbooleanWhether the call completed.
messagestringA one-line summary of what happened, suitable for showing a human.
error_codestringPresent only on failure — a stable machine-readable reason, such as a missing field, a wrong field type or an unmet confirmation.

Example

Ask your assistant:

Create an API key for the integration.

It resolves to one call:

{
  "ability": "mailerpress/manage-api-keys",
  "parameters": {
    "action": "create",
    "name": "CRM integration"
  }
}

Worth knowing

  • The raw key is returned once. Capture it or start again.
  • Revoke is reversible; delete is not.
  • Revoke first, observe what breaks, then delete.
  • These keys reach contact data. A leak is an exposure.

Related abilities


Get the plugins:
AcrossAI Abilities Manager · AcrossAI MCP Manager

Browse the rest: Every ability, by category


Keep reading