instantly-install-auth

name	instantly-install-auth
description	Set up Instantly.ai API v2 authentication and project configuration. Use when creating a new Instantly integration, generating API keys, or configuring environment variables for the Instantly outreach platform. Trigger with phrases like "install instantly", "setup instantly", "instantly auth", "configure instantly API key", "instantly credentials".
allowed-tools	Read, Write, Edit, Bash(npm:*), Bash(pip:*), Bash(curl:*), Grep
version	1.12.0
license	MIT
author	Jeremy Longshore <[e-mail]>
tags	["saas","instantly","api","authentication","email-outreach"]
compatibility	Designed for Claude Code, also compatible with Codex and OpenClaw

Instantly Install & Auth

Overview

Configure Instantly.ai API v2 authentication. Instantly uses Bearer token auth with scoped API keys. There is no official SDK — all integrations use direct REST calls to https://api.instantly.ai/api/v2/.

Prerequisites

• Instantly.ai account on Hypergrowth plan ($97/mo) or higher (required for API v2 access)
• Node.js 18+ or Python 3.10+
• Access to Instantly dashboard at https://app.instantly.ai

Instructions

Step 1: Generate API Key

1. Log into https://app.instantly.ai
2. Navigate to Settings > Integrations > API
3. Click Create New API Key
4. Select scopes (e.g., campaigns:read, leads:all, accounts:read)
5. Copy the key — it is shown only once

set -euo pipefail
# Create .env file with your API key
cat > .env << 'ENVEOF'
INSTANTLY_API_KEY=your-api-key-here
INSTANTLY_BASE_URL=https://api.instantly.ai/api/v2
ENVEOF
echo "Created .env with Instantly config"

Available API scopes (resource:action format):

Scope	Access
campaigns:read	List/get campaigns and analytics
campaigns:update	Create, patch, activate, pause campaigns
campaigns:all	Full campaign CRUD + analytics
accounts:read	List/get email accounts
accounts:update	Create, warmup, pause accounts
leads:read	List/get leads and lead lists
leads:update	Create, move, delete leads
leads:all	Full lead CRUD
all:all