instantly-hello-world

Featured

Create a minimal working Instantly.ai example with real API calls. Use when starting a new Instantly integration, testing your setup, or learning basic Instantly API v2 patterns. Trigger with phrases like "instantly hello world", "instantly example", "instantly quick start", "simple instantly code", "test instantly api".

AI & Automation 2,926 stars 433 forks Updated yesterday MIT

Install

View on GitHub

Quality Score: 99/100

Stars 20%
100
Recency 20%
100
Frontmatter 20%
70
Documentation 15%
100
Issue Health 10%
50
License 10%
100
Description 5%
100

Skill Content

# Instantly Hello World ## Overview Minimal working example that lists your campaigns, checks email account health, and pulls campaign analytics — all using real Instantly API v2 endpoints. ## Prerequisites - Completed `instantly-install-auth` setup - At least one email account connected in Instantly - `INSTANTLY_API_KEY` environment variable set ## Instructions ### Step 1: List Your Campaigns ```typescript import { instantly } from "./src/instantly"; interface Campaign { id: string; name: string; status: number; // 0=Draft, 1=Active, 2=Paused, 3=Completed } const STATUS_LABELS: Record<number, string> = { 0: "Draft", 1: "Active", 2: "Paused", 3: "Completed", 4: "Running Subsequences", [-99]: "Suspended", [-1]: "Accounts Unhealthy", [-2]: "Bounce Protect", }; async function listCampaigns() { const campaigns = await instantly<Campaign[]>("/campaigns?limit=10"); console.log(`Found ${campaigns.length} campaigns:\n`); for (const c of campaigns) { console.log(` ${c.name} [${STATUS_LABELS[c.status] ?? c.status}] — ${c.id}`); } return campaigns; } ``` ### Step 2: Check Email Account Health ```typescript interface Account { email: string; status: number; warmup_status: string; daily_limit: number | null; } async function checkAccounts() { const accounts = await instantly<Account[]>("/accounts?limit=5"); console.log(`\nEmail Accounts (${accounts.length}):`); for (const a of accounts) { console.log(` ${a.email} — status: ${a.statu...

Details

Author
jeremylongshore
Repository
jeremylongshore/claude-code-plugins-plus-skills
Created
1 years ago
Last Updated
yesterday
Language
Python
License
MIT

Integrates with

Bundled in these plugins

Similar Skills

Semantically similar based on skill content — not just same category