Getting Started
Quick Start
Send your first outreach campaign in 5 minutes.
Quick Start
1. Get your API Key
Navigate to Settings → API Keys in your organization dashboard and create
a new key with full-access scope.
2. Install the CLI (optional)
npm install -g @Pipelime/cli
Pipelime auth login --api-key ki_your_key_here3. Connect an Email Account
Connect your Gmail account in Settings → Email Accounts.
4. Create a Campaign
# Via CLI
Pipelime campaign create --name "My First Campaign"
# Via API
curl -X POST https://app.Pipelime.io/api/campaigns \
-H "Authorization: Bearer ki_your_key" \
-H "Content-Type: application/json" \
-d '{"name": "My First Campaign"}'5. Add Steps
Pipelime campaign add-step <campaign-id> \
--subject "Hi {{first_name | \"there\"}}, quick question" \
--body "<p>I noticed {{company_name}} is growing fast...</p>" \
--delay-days 06. Add Contacts
Pipelime contact create \
--email john@example.com \
--first-name John \
--company-name "Pipelime"
Pipelime campaign add-contacts <campaign-id> \
--contact-ids <contact-id>7. Activate
Pipelime campaign start <campaign-id>Your campaign is now running. Emails will be sent according to your schedule.
Next Steps
- Authentication — Learn about API keys, rate limits, and idempotency
- Campaign Guide — Deep dive into campaign lifecycle and configuration
- CLI Setup — Full CLI installation and configuration guide