ahasend apikeys: Manage API Keys

Create, list, update, and delete scoped AhaSend API keys from the command line, including domain-restricted keys such as messages:send:.

AhaSend CLI apikeys commands let you create, inspect, update and revoke API keys; this page covers their arguments and flags.

Before running the examples, log in with a full API key, use your verified sender domain, and replace YOUR_RESOURCE_ID with a resource UUID from your test account. Create any named template, recipient, attachment, or JSON files first. Shell examples use Bash; examples that read JSON with jq need jq installed. Sends use sandbox mode.

Overview

ahasend apikeys [subcommand] [flags]

Available subcommands:

• list - List all API keys
• create - Create a new API key
• get - Get detailed information about a specific API key
• update - Update an existing API key
• delete - Delete an API key

API keys are used to authenticate requests to the AhaSend API. You can create multiple API keys with different scopes and labels to organize access for different applications or team members.

Each API key has:

• A unique identifier and secret
• Configurable scopes (permissions) - see API Key Scopes
• Optional labels for organization
• Creation and last used timestamps

List API Keys

ahasend apikeys list

Create API Key

# Send messages from any domain
ahasend apikeys create --label "Production API" --scope "messages:send:all"

# Multiple specific scopes
ahasend apikeys create \
  --label "Analytics Only" \
  --scope "statistics-transactional:read:all" \
  --scope "suppressions:read"

# Domain-specific messaging
ahasend apikeys create \
  --label "Newsletter Service" \
  --scope "messages:send:{example.com}" \
  --scope "suppressions:write"

Get API Key Details

ahasend apikeys get YOUR_RESOURCE_ID

Update API Key

# Update label
ahasend apikeys update YOUR_RESOURCE_ID --label "Updated Label"

# Update scope
ahasend apikeys update YOUR_RESOURCE_ID --scope "messages:send:{example.com}"

Delete API Key

TEST_ID=$(ahasend apikeys create --label "Docs deletion test" --scope "accounts:read" --output json | jq -er '.id')
ahasend apikeys delete "$TEST_ID"

Deleting an API key is irreversible. Applications using this key will lose access immediately.

Next Steps

• Learn about API Key Scopes
• Authenticate with the CLI
• Send messages

Command Flags

These flags come from the current CLI. All commands also accept the global flags.

apikeys create

Flag	Description and default
--label string	Label for the API key (required)
--scope strings	Scopes to grant (required, can be used multiple times)

apikeys delete

Flag	Description and default
--force	Skip confirmation prompt

apikeys get

This command has no command-specific flags. See global flags.

apikeys list

Flag	Description and default
--cursor string	Pagination cursor for next page
--limit int32	Maximum number of API keys to return (1-100) (default 20)

apikeys update

Flag	Description and default
--label string	New label for the API key
--scope strings	New scopes to grant (replaces existing scopes)

Related Guides

• Install the CLI, CLI authentication, Permission scopes.
• Scoped credentials, Create key API, IP allow lists.
• CLI configuration and output, API authentication, Domain setup.
• Sandbox behavior, Suppression durations.