Navigation
SuperSend

CLI

Install and use the SuperSend CLI to manage teams, contacts, campaigns, and deliverability from the terminal


The SuperSend CLI (supersend) talks to the customer V2 API with your organization’s API key. It ships in the same npm package as the MCP server.

ℹ️

API key

Copy your org API key from Admin → System under IDs → API Key → Copy. Prefer env or supersend config set-api-key — avoid pasting keys into shell history when possible.

Requirements

  • Node.js 18+

  • A SuperSend organization API key

    • Install

    bash
    npx -y -p @super-send/mcp-server supersend --help
    npx -y -p @super-send/mcp-server supersend health

    Auth

    Pick one (checked in this order: flag → env → config file):

    bash
    # env (current shell)
    export SUPERSEND_API_KEY='your-api-key'
    # optional — production is the default
    export SUPERSEND_API_URL='https://api.supersend.io/v2'
    # or save to ~/.config/supersend/config.json
    supersend config set-api-key 'your-api-key'
    # or one-off flag
    supersend --api-key 'your-api-key' health

    Quick start

    bash
    supersend health
    supersend teams list
    supersend contacts list --team-id <team-uuid> --limit 5
    supersend campaigns list --team-id <team-uuid> --limit 5

    Discover commands:

    bash
    supersend --help
    supersend contacts --help
    supersend diagnose capacity --help

    Global flags

    FlagDescription
    --api-key <key>Organization API key
    --api-url <url>V2 base URL (default https://api.supersend.io/v2)
    --jsonPretty JSON on stdout (default)
    --help / --versionHelp and package version


    Errors print to stderr and exit non-zero.

    What the CLI does not do

  • Domain / mailbox purchase

  • OAuth / mailbox connect flows

  • LinkedIn channel params (gated / omitted)

    • For AI assistants, use the MCP Server instead of (or in addition to) the CLI.

    Related

  • MCP Server — connect Cursor, Claude, Codex, and other agents

  • Authentication — API keys and V2 auth

  • V2 API Overview — REST reference