@miranda0808/maya-codex 0.1.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +30 -0
- package/bin/maya-codex.js +36 -0
- package/package.json +19 -0
- package/payload/.agents/skills/ab-test-setup/SKILL.md +266 -0
- package/payload/.agents/skills/ab-test-setup/evals/evals.json +105 -0
- package/payload/.agents/skills/ab-test-setup/references/sample-size-guide.md +263 -0
- package/payload/.agents/skills/ab-test-setup/references/test-templates.md +277 -0
- package/payload/.agents/skills/ad-creative/SKILL.md +362 -0
- package/payload/.agents/skills/ad-creative/evals/evals.json +90 -0
- package/payload/.agents/skills/ad-creative/references/generative-tools.md +637 -0
- package/payload/.agents/skills/ad-creative/references/platform-specs.md +213 -0
- package/payload/.agents/skills/ai-seo/SKILL.md +398 -0
- package/payload/.agents/skills/ai-seo/evals/evals.json +90 -0
- package/payload/.agents/skills/ai-seo/references/content-patterns.md +285 -0
- package/payload/.agents/skills/ai-seo/references/platform-ranking-factors.md +152 -0
- package/payload/.agents/skills/analytics-tracking/SKILL.md +309 -0
- package/payload/.agents/skills/analytics-tracking/evals/evals.json +90 -0
- package/payload/.agents/skills/analytics-tracking/references/event-library.md +260 -0
- package/payload/.agents/skills/analytics-tracking/references/ga4-implementation.md +300 -0
- package/payload/.agents/skills/analytics-tracking/references/gtm-implementation.md +390 -0
- package/payload/.agents/skills/churn-prevention/SKILL.md +424 -0
- package/payload/.agents/skills/churn-prevention/evals/evals.json +93 -0
- package/payload/.agents/skills/churn-prevention/references/cancel-flow-patterns.md +316 -0
- package/payload/.agents/skills/churn-prevention/references/dunning-playbook.md +408 -0
- package/payload/.agents/skills/cold-email/SKILL.md +158 -0
- package/payload/.agents/skills/cold-email/evals/evals.json +94 -0
- package/payload/.agents/skills/cold-email/references/benchmarks.md +83 -0
- package/payload/.agents/skills/cold-email/references/follow-up-sequences.md +81 -0
- package/payload/.agents/skills/cold-email/references/frameworks.md +90 -0
- package/payload/.agents/skills/cold-email/references/personalization.md +79 -0
- package/payload/.agents/skills/cold-email/references/subject-lines.md +53 -0
- package/payload/.agents/skills/competitor-alternatives/SKILL.md +256 -0
- package/payload/.agents/skills/competitor-alternatives/evals/evals.json +93 -0
- package/payload/.agents/skills/competitor-alternatives/references/content-architecture.md +271 -0
- package/payload/.agents/skills/competitor-alternatives/references/templates.md +223 -0
- package/payload/.agents/skills/content-strategy/SKILL.md +359 -0
- package/payload/.agents/skills/content-strategy/evals/evals.json +90 -0
- package/payload/.agents/skills/copy-editing/SKILL.md +447 -0
- package/payload/.agents/skills/copy-editing/evals/evals.json +89 -0
- package/payload/.agents/skills/copy-editing/references/plain-english-alternatives.md +394 -0
- package/payload/.agents/skills/copywriting/SKILL.md +252 -0
- package/payload/.agents/skills/copywriting/evals/evals.json +111 -0
- package/payload/.agents/skills/copywriting/references/copy-frameworks.md +344 -0
- package/payload/.agents/skills/copywriting/references/natural-transitions.md +272 -0
- package/payload/.agents/skills/email-sequence/SKILL.md +309 -0
- package/payload/.agents/skills/email-sequence/evals/evals.json +93 -0
- package/payload/.agents/skills/email-sequence/references/copy-guidelines.md +113 -0
- package/payload/.agents/skills/email-sequence/references/email-types.md +515 -0
- package/payload/.agents/skills/email-sequence/references/sequence-templates.md +168 -0
- package/payload/.agents/skills/form-cro/SKILL.md +429 -0
- package/payload/.agents/skills/form-cro/evals/evals.json +90 -0
- package/payload/.agents/skills/free-tool-strategy/SKILL.md +178 -0
- package/payload/.agents/skills/free-tool-strategy/evals/evals.json +90 -0
- package/payload/.agents/skills/free-tool-strategy/references/tool-types.md +217 -0
- package/payload/.agents/skills/launch-strategy/SKILL.md +353 -0
- package/payload/.agents/skills/launch-strategy/evals/evals.json +91 -0
- package/payload/.agents/skills/marketing-ideas/SKILL.md +167 -0
- package/payload/.agents/skills/marketing-ideas/evals/evals.json +90 -0
- package/payload/.agents/skills/marketing-ideas/references/ideas-by-category.md +366 -0
- package/payload/.agents/skills/marketing-psychology/SKILL.md +455 -0
- package/payload/.agents/skills/marketing-psychology/evals/evals.json +88 -0
- package/payload/.agents/skills/onboarding-cro/SKILL.md +220 -0
- package/payload/.agents/skills/onboarding-cro/evals/evals.json +92 -0
- package/payload/.agents/skills/onboarding-cro/references/experiments.md +258 -0
- package/payload/.agents/skills/page-cro/SKILL.md +182 -0
- package/payload/.agents/skills/page-cro/evals/evals.json +111 -0
- package/payload/.agents/skills/page-cro/references/experiments.md +248 -0
- package/payload/.agents/skills/paid-ads/SKILL.md +315 -0
- package/payload/.agents/skills/paid-ads/evals/evals.json +90 -0
- package/payload/.agents/skills/paid-ads/references/ad-copy-templates.md +207 -0
- package/payload/.agents/skills/paid-ads/references/audience-targeting.md +243 -0
- package/payload/.agents/skills/paid-ads/references/platform-setup-checklists.md +277 -0
- package/payload/.agents/skills/paywall-upgrade-cro/SKILL.md +227 -0
- package/payload/.agents/skills/paywall-upgrade-cro/evals/evals.json +93 -0
- package/payload/.agents/skills/paywall-upgrade-cro/references/experiments.md +164 -0
- package/payload/.agents/skills/popup-cro/SKILL.md +453 -0
- package/payload/.agents/skills/popup-cro/evals/evals.json +94 -0
- package/payload/.agents/skills/pricing-strategy/SKILL.md +231 -0
- package/payload/.agents/skills/pricing-strategy/evals/evals.json +90 -0
- package/payload/.agents/skills/pricing-strategy/references/research-methods.md +152 -0
- package/payload/.agents/skills/pricing-strategy/references/tier-structure.md +232 -0
- package/payload/.agents/skills/product-marketing-context/SKILL.md +27 -0
- package/payload/.agents/skills/product-marketing-context/evals/evals.json +40 -0
- package/payload/.agents/skills/programmatic-seo/SKILL.md +238 -0
- package/payload/.agents/skills/programmatic-seo/evals/evals.json +94 -0
- package/payload/.agents/skills/programmatic-seo/references/playbooks.md +308 -0
- package/payload/.agents/skills/referral-program/SKILL.md +255 -0
- package/payload/.agents/skills/referral-program/evals/evals.json +89 -0
- package/payload/.agents/skills/referral-program/references/affiliate-programs.md +164 -0
- package/payload/.agents/skills/referral-program/references/program-examples.md +143 -0
- package/payload/.agents/skills/revops/SKILL.md +343 -0
- package/payload/.agents/skills/revops/evals/evals.json +91 -0
- package/payload/.agents/skills/revops/references/automation-playbooks.md +290 -0
- package/payload/.agents/skills/revops/references/lifecycle-definitions.md +278 -0
- package/payload/.agents/skills/revops/references/routing-rules.md +203 -0
- package/payload/.agents/skills/revops/references/scoring-models.md +247 -0
- package/payload/.agents/skills/sales-enablement/SKILL.md +349 -0
- package/payload/.agents/skills/sales-enablement/evals/evals.json +91 -0
- package/payload/.agents/skills/sales-enablement/references/deck-frameworks.md +263 -0
- package/payload/.agents/skills/sales-enablement/references/demo-scripts.md +355 -0
- package/payload/.agents/skills/sales-enablement/references/objection-library.md +270 -0
- package/payload/.agents/skills/sales-enablement/references/one-pager-templates.md +208 -0
- package/payload/.agents/skills/schema-markup/SKILL.md +179 -0
- package/payload/.agents/skills/schema-markup/evals/evals.json +87 -0
- package/payload/.agents/skills/schema-markup/references/schema-examples.md +398 -0
- package/payload/.agents/skills/seo-audit/SKILL.md +412 -0
- package/payload/.agents/skills/seo-audit/evals/evals.json +136 -0
- package/payload/.agents/skills/seo-audit/references/ai-writing-detection.md +200 -0
- package/payload/.agents/skills/signup-flow-cro/SKILL.md +359 -0
- package/payload/.agents/skills/signup-flow-cro/evals/evals.json +88 -0
- package/payload/.agents/skills/site-architecture/SKILL.md +357 -0
- package/payload/.agents/skills/site-architecture/evals/evals.json +88 -0
- package/payload/.agents/skills/site-architecture/references/mermaid-templates.md +216 -0
- package/payload/.agents/skills/site-architecture/references/navigation-patterns.md +305 -0
- package/payload/.agents/skills/site-architecture/references/site-type-templates.md +293 -0
- package/payload/.agents/skills/social-content/SKILL.md +278 -0
- package/payload/.agents/skills/social-content/evals/evals.json +92 -0
- package/payload/.agents/skills/social-content/references/platforms.md +170 -0
- package/payload/.agents/skills/social-content/references/post-templates.md +177 -0
- package/payload/.agents/skills/social-content/references/reverse-engineering.md +195 -0
- package/payload/.maya/executor.md +79 -0
- package/payload/.maya/meta-api-agent.md +48 -0
- package/payload/.maya/modes/consult.md +63 -0
- package/payload/.maya/modes/task.md +97 -0
- package/payload/.maya/planner.md +69 -0
- package/payload/.maya/researcher.md +51 -0
- package/payload/.maya/templates/plan.md +77 -0
- package/payload/.maya/templates/state.md +87 -0
- package/payload/.maya/templates/task-packet.md +75 -0
- package/payload/MAYA-CATALOG.md +115 -0
- package/payload/MAYA-DEPENDENCIES.md +58 -0
- package/payload/MAYA.md +151 -0
- package/payload/campaigns/README.md +14 -0
- package/payload/commands/maya-consult.md +28 -0
- package/payload/commands/maya-task.md +38 -0
- package/payload/commands/product.md +55 -0
- package/payload/research/README.md +14 -0
- package/payload/templates/README.md +15 -0
- package/payload/templates/plan.md +77 -0
- package/payload/templates/state.md +87 -0
- package/payload/templates/task-packet.md +75 -0
- package/payload/tools/REGISTRY.md +368 -0
- package/payload/tools/clis/README.md +187 -0
- package/payload/tools/clis/activecampaign.js +435 -0
- package/payload/tools/clis/adobe-analytics.js +161 -0
- package/payload/tools/clis/ahrefs.js +192 -0
- package/payload/tools/clis/amplitude.js +182 -0
- package/payload/tools/clis/apollo.js +142 -0
- package/payload/tools/clis/beehiiv.js +245 -0
- package/payload/tools/clis/brevo.js +368 -0
- package/payload/tools/clis/buffer.js +260 -0
- package/payload/tools/clis/calendly.js +253 -0
- package/payload/tools/clis/clearbit.js +163 -0
- package/payload/tools/clis/customer-io.js +205 -0
- package/payload/tools/clis/dataforseo.js +257 -0
- package/payload/tools/clis/demio.js +149 -0
- package/payload/tools/clis/dub.js +158 -0
- package/payload/tools/clis/g2.js +186 -0
- package/payload/tools/clis/ga4.js +194 -0
- package/payload/tools/clis/google-ads.js +189 -0
- package/payload/tools/clis/google-search-console.js +166 -0
- package/payload/tools/clis/hotjar.js +167 -0
- package/payload/tools/clis/hunter.js +249 -0
- package/payload/tools/clis/instantly.js +270 -0
- package/payload/tools/clis/intercom.js +399 -0
- package/payload/tools/clis/keywords-everywhere.js +185 -0
- package/payload/tools/clis/kit.js +232 -0
- package/payload/tools/clis/klaviyo.js +348 -0
- package/payload/tools/clis/lemlist.js +221 -0
- package/payload/tools/clis/linkedin-ads.js +185 -0
- package/payload/tools/clis/livestorm.js +292 -0
- package/payload/tools/clis/mailchimp.js +220 -0
- package/payload/tools/clis/mention-me.js +161 -0
- package/payload/tools/clis/meta-ads.js +181 -0
- package/payload/tools/clis/mixpanel.js +248 -0
- package/payload/tools/clis/onesignal.js +241 -0
- package/payload/tools/clis/optimizely.js +233 -0
- package/payload/tools/clis/paddle.js +385 -0
- package/payload/tools/clis/partnerstack.js +382 -0
- package/payload/tools/clis/plausible.js +249 -0
- package/payload/tools/clis/postmark.js +375 -0
- package/payload/tools/clis/resend.js +370 -0
- package/payload/tools/clis/rewardful.js +160 -0
- package/payload/tools/clis/savvycal.js +223 -0
- package/payload/tools/clis/segment.js +192 -0
- package/payload/tools/clis/semrush.js +207 -0
- package/payload/tools/clis/sendgrid.js +211 -0
- package/payload/tools/clis/snov.js +237 -0
- package/payload/tools/clis/tiktok-ads.js +190 -0
- package/payload/tools/clis/tolt.js +153 -0
- package/payload/tools/clis/trustpilot.js +276 -0
- package/payload/tools/clis/typeform.js +269 -0
- package/payload/tools/clis/wistia.js +256 -0
- package/payload/tools/clis/zapier.js +160 -0
- package/payload/tools/integrations/activecampaign.md +337 -0
- package/payload/tools/integrations/adobe-analytics.md +156 -0
- package/payload/tools/integrations/ahrefs.md +142 -0
- package/payload/tools/integrations/amplitude.md +135 -0
- package/payload/tools/integrations/apollo.md +148 -0
- package/payload/tools/integrations/beehiiv.md +157 -0
- package/payload/tools/integrations/brevo.md +268 -0
- package/payload/tools/integrations/buffer.md +138 -0
- package/payload/tools/integrations/calendly.md +161 -0
- package/payload/tools/integrations/clearbit.md +142 -0
- package/payload/tools/integrations/customer-io.md +187 -0
- package/payload/tools/integrations/dataforseo.md +165 -0
- package/payload/tools/integrations/demio.md +182 -0
- package/payload/tools/integrations/dub-co.md +160 -0
- package/payload/tools/integrations/g2.md +179 -0
- package/payload/tools/integrations/ga4.md +126 -0
- package/payload/tools/integrations/google-ads.md +159 -0
- package/payload/tools/integrations/google-search-console.md +147 -0
- package/payload/tools/integrations/hotjar.md +147 -0
- package/payload/tools/integrations/hubspot.md +178 -0
- package/payload/tools/integrations/hunter.md +90 -0
- package/payload/tools/integrations/instantly.md +104 -0
- package/payload/tools/integrations/intercom.md +292 -0
- package/payload/tools/integrations/keywords-everywhere.md +207 -0
- package/payload/tools/integrations/kit.md +167 -0
- package/payload/tools/integrations/klaviyo.md +228 -0
- package/payload/tools/integrations/lemlist.md +110 -0
- package/payload/tools/integrations/linkedin-ads.md +164 -0
- package/payload/tools/integrations/livestorm.md +313 -0
- package/payload/tools/integrations/mailchimp.md +150 -0
- package/payload/tools/integrations/mention-me.md +160 -0
- package/payload/tools/integrations/meta-ads.md +147 -0
- package/payload/tools/integrations/mixpanel.md +137 -0
- package/payload/tools/integrations/onesignal.md +229 -0
- package/payload/tools/integrations/optimizely.md +171 -0
- package/payload/tools/integrations/paddle.md +212 -0
- package/payload/tools/integrations/partnerstack.md +222 -0
- package/payload/tools/integrations/plausible.md +177 -0
- package/payload/tools/integrations/posthog.md +151 -0
- package/payload/tools/integrations/postmark.md +234 -0
- package/payload/tools/integrations/resend.md +168 -0
- package/payload/tools/integrations/rewardful.md +147 -0
- package/payload/tools/integrations/salesforce.md +150 -0
- package/payload/tools/integrations/savvycal.md +181 -0
- package/payload/tools/integrations/segment.md +159 -0
- package/payload/tools/integrations/semrush.md +121 -0
- package/payload/tools/integrations/sendgrid.md +161 -0
- package/payload/tools/integrations/shopify.md +176 -0
- package/payload/tools/integrations/snov.md +94 -0
- package/payload/tools/integrations/stripe.md +148 -0
- package/payload/tools/integrations/tiktok-ads.md +161 -0
- package/payload/tools/integrations/tolt.md +144 -0
- package/payload/tools/integrations/trustpilot.md +191 -0
- package/payload/tools/integrations/typeform.md +190 -0
- package/payload/tools/integrations/webflow.md +198 -0
- package/payload/tools/integrations/wistia.md +164 -0
- package/payload/tools/integrations/wordpress.md +175 -0
- package/payload/tools/integrations/zapier.md +150 -0
- package/payload/tools/meta/README.md +55 -0
- package/payload/tools/meta/meta-cache-schema.md +65 -0
- package/payload/tools/meta/meta-fetch.ps1 +324 -0
- package/payload/tools/meta/meta-fetch.test.ps1 +38 -0
- package/vendor/shared-installer/manifests/claude-files.json +13 -0
- package/vendor/shared-installer/manifests/codex-files.json +13 -0
- package/vendor/shared-installer/manifests/common-files.json +13 -0
- package/vendor/shared-installer/package.json +15 -0
- package/vendor/shared-installer/src/bootstrap.js +12 -0
- package/vendor/shared-installer/src/cli-options.js +53 -0
- package/vendor/shared-installer/src/fs.js +105 -0
- package/vendor/shared-installer/src/index.js +44 -0
- package/vendor/shared-installer/src/install.js +157 -0
- package/vendor/shared-installer/src/manifest.js +52 -0
- package/vendor/shared-installer/templates/claude/.claude/skills/.gitkeep +1 -0
- package/vendor/shared-installer/templates/claude/CLAUDE.md +27 -0
- package/vendor/shared-installer/templates/codex/.agent/skills/.gitkeep +1 -0
- package/vendor/shared-installer/templates/codex/AGENTS.md +27 -0
|
@@ -0,0 +1,135 @@
|
|
|
1
|
+
# Amplitude
|
|
2
|
+
|
|
3
|
+
Product analytics platform for user behavior, retention, and experimentation.
|
|
4
|
+
|
|
5
|
+
## Capabilities
|
|
6
|
+
|
|
7
|
+
| Integration | Available | Notes |
|
|
8
|
+
|-------------|-----------|-------|
|
|
9
|
+
| API | ✓ | HTTP API for events, User Profile API, Export API |
|
|
10
|
+
| MCP | - | Not available |
|
|
11
|
+
| CLI | - | Not available |
|
|
12
|
+
| SDK | ✓ | JavaScript, iOS, Android, Python, etc. |
|
|
13
|
+
|
|
14
|
+
## Authentication
|
|
15
|
+
|
|
16
|
+
- **HTTP API**: API Key (public for events)
|
|
17
|
+
- **Export/Dashboard API**: API Key + Secret Key
|
|
18
|
+
|
|
19
|
+
## Common Agent Operations
|
|
20
|
+
|
|
21
|
+
### Track event
|
|
22
|
+
|
|
23
|
+
```bash
|
|
24
|
+
POST https://api2.amplitude.com/2/httpapi
|
|
25
|
+
|
|
26
|
+
{
|
|
27
|
+
"api_key": "{api_key}",
|
|
28
|
+
"events": [{
|
|
29
|
+
"user_id": "user_123",
|
|
30
|
+
"event_type": "signup_completed",
|
|
31
|
+
"event_properties": {
|
|
32
|
+
"plan": "pro"
|
|
33
|
+
},
|
|
34
|
+
"user_properties": {
|
|
35
|
+
"email": "user@example.com"
|
|
36
|
+
}
|
|
37
|
+
}]
|
|
38
|
+
}
|
|
39
|
+
```
|
|
40
|
+
|
|
41
|
+
### Batch events
|
|
42
|
+
|
|
43
|
+
```bash
|
|
44
|
+
POST https://api2.amplitude.com/batch
|
|
45
|
+
|
|
46
|
+
{
|
|
47
|
+
"api_key": "{api_key}",
|
|
48
|
+
"events": [
|
|
49
|
+
{"user_id": "user_1", "event_type": "pageview"},
|
|
50
|
+
{"user_id": "user_2", "event_type": "signup"}
|
|
51
|
+
]
|
|
52
|
+
}
|
|
53
|
+
```
|
|
54
|
+
|
|
55
|
+
### Get user activity
|
|
56
|
+
|
|
57
|
+
```bash
|
|
58
|
+
GET https://amplitude.com/api/2/useractivity?user={user_id}
|
|
59
|
+
|
|
60
|
+
Authorization: Basic {base64(api_key:secret_key)}
|
|
61
|
+
```
|
|
62
|
+
|
|
63
|
+
### Export events
|
|
64
|
+
|
|
65
|
+
```bash
|
|
66
|
+
GET https://amplitude.com/api/2/export?start=20240101T00&end=20240131T23
|
|
67
|
+
|
|
68
|
+
Authorization: Basic {base64(api_key:secret_key)}
|
|
69
|
+
```
|
|
70
|
+
|
|
71
|
+
### Get retention data
|
|
72
|
+
|
|
73
|
+
```bash
|
|
74
|
+
GET https://amplitude.com/api/2/retention?e={"event_type":"signup_completed"}&start=20240101&end=20240131
|
|
75
|
+
|
|
76
|
+
Authorization: Basic {base64(api_key:secret_key)}
|
|
77
|
+
```
|
|
78
|
+
|
|
79
|
+
### Query with SQL (Snowflake)
|
|
80
|
+
|
|
81
|
+
For Amplitude customers with SQL access:
|
|
82
|
+
```sql
|
|
83
|
+
SELECT event_type, COUNT(*) as count
|
|
84
|
+
FROM events
|
|
85
|
+
WHERE event_time > '2024-01-01'
|
|
86
|
+
GROUP BY event_type
|
|
87
|
+
```
|
|
88
|
+
|
|
89
|
+
## JavaScript SDK
|
|
90
|
+
|
|
91
|
+
```javascript
|
|
92
|
+
// Initialize
|
|
93
|
+
amplitude.init('API_KEY');
|
|
94
|
+
|
|
95
|
+
// Identify user
|
|
96
|
+
amplitude.setUserId('user_123');
|
|
97
|
+
|
|
98
|
+
// Set user properties
|
|
99
|
+
const identify = new amplitude.Identify();
|
|
100
|
+
identify.set('plan', 'pro');
|
|
101
|
+
amplitude.identify(identify);
|
|
102
|
+
|
|
103
|
+
// Track event
|
|
104
|
+
amplitude.track('Feature Used', {
|
|
105
|
+
feature_name: 'export'
|
|
106
|
+
});
|
|
107
|
+
```
|
|
108
|
+
|
|
109
|
+
## Key Concepts
|
|
110
|
+
|
|
111
|
+
- **Events** - User actions with properties
|
|
112
|
+
- **User Properties** - Persistent user attributes
|
|
113
|
+
- **Cohorts** - Behavioral segments
|
|
114
|
+
- **Funnels** - Multi-step conversion analysis
|
|
115
|
+
- **Retention** - User return patterns
|
|
116
|
+
- **Journeys** - User path analysis
|
|
117
|
+
|
|
118
|
+
## When to Use
|
|
119
|
+
|
|
120
|
+
- Tracking product analytics
|
|
121
|
+
- Analyzing user funnels
|
|
122
|
+
- Cohort analysis and retention
|
|
123
|
+
- Experimentation and A/B testing
|
|
124
|
+
- User journey mapping
|
|
125
|
+
|
|
126
|
+
## Rate Limits
|
|
127
|
+
|
|
128
|
+
- HTTP API: 1000 events/second
|
|
129
|
+
- Export API: 360 requests/hour
|
|
130
|
+
|
|
131
|
+
## Relevant Skills
|
|
132
|
+
|
|
133
|
+
- analytics-tracking
|
|
134
|
+
- ab-test-setup
|
|
135
|
+
- onboarding-cro
|
|
@@ -0,0 +1,148 @@
|
|
|
1
|
+
# Apollo.io
|
|
2
|
+
|
|
3
|
+
B2B prospecting and data enrichment platform with 210M+ contacts and 35M+ companies for sales intelligence.
|
|
4
|
+
|
|
5
|
+
## Capabilities
|
|
6
|
+
|
|
7
|
+
| Integration | Available | Notes |
|
|
8
|
+
|-------------|-----------|-------|
|
|
9
|
+
| API | ✓ | People Search, Company Search, Enrichment, Sequences |
|
|
10
|
+
| MCP | - | Not available |
|
|
11
|
+
| CLI | ✓ | [apollo.js](../clis/apollo.js) |
|
|
12
|
+
| SDK | - | REST API only |
|
|
13
|
+
|
|
14
|
+
## Authentication
|
|
15
|
+
|
|
16
|
+
- **Type**: API Key
|
|
17
|
+
- **Header**: `x-api-key: {api_key}` or `Authorization: Bearer {token}`
|
|
18
|
+
- **Get key**: Settings > Integrations > API at https://app.apollo.io
|
|
19
|
+
|
|
20
|
+
## Common Agent Operations
|
|
21
|
+
|
|
22
|
+
### People Search
|
|
23
|
+
|
|
24
|
+
```bash
|
|
25
|
+
POST https://api.apollo.io/api/v1/mixed_people/api_search
|
|
26
|
+
|
|
27
|
+
{
|
|
28
|
+
"person_titles": ["Sales Manager"],
|
|
29
|
+
"person_locations": ["United States"],
|
|
30
|
+
"organization_num_employees_ranges": ["1,100"],
|
|
31
|
+
"page": 1
|
|
32
|
+
}
|
|
33
|
+
```
|
|
34
|
+
|
|
35
|
+
### Person Enrichment
|
|
36
|
+
|
|
37
|
+
```bash
|
|
38
|
+
POST https://api.apollo.io/api/v1/people/match
|
|
39
|
+
|
|
40
|
+
{
|
|
41
|
+
"first_name": "Tim",
|
|
42
|
+
"last_name": "Zheng",
|
|
43
|
+
"domain": "apollo.io"
|
|
44
|
+
}
|
|
45
|
+
```
|
|
46
|
+
|
|
47
|
+
### Bulk People Enrichment
|
|
48
|
+
|
|
49
|
+
```bash
|
|
50
|
+
POST https://api.apollo.io/api/v1/people/bulk_match
|
|
51
|
+
|
|
52
|
+
{
|
|
53
|
+
"details": [
|
|
54
|
+
{ "email": "tim@apollo.io" },
|
|
55
|
+
{ "first_name": "Jane", "last_name": "Doe", "domain": "example.com" }
|
|
56
|
+
]
|
|
57
|
+
}
|
|
58
|
+
```
|
|
59
|
+
|
|
60
|
+
### Organization Search
|
|
61
|
+
|
|
62
|
+
```bash
|
|
63
|
+
POST https://api.apollo.io/api/v1/mixed_companies/search
|
|
64
|
+
|
|
65
|
+
{
|
|
66
|
+
"organization_locations": ["United States"],
|
|
67
|
+
"organization_num_employees_ranges": ["1,100"],
|
|
68
|
+
"page": 1
|
|
69
|
+
}
|
|
70
|
+
```
|
|
71
|
+
|
|
72
|
+
### Organization Enrichment
|
|
73
|
+
|
|
74
|
+
```bash
|
|
75
|
+
POST https://api.apollo.io/api/v1/organizations/enrich
|
|
76
|
+
|
|
77
|
+
{
|
|
78
|
+
"domain": "apollo.io"
|
|
79
|
+
}
|
|
80
|
+
```
|
|
81
|
+
|
|
82
|
+
## Key Metrics
|
|
83
|
+
|
|
84
|
+
### Person Data
|
|
85
|
+
- `first_name`, `last_name` - Name
|
|
86
|
+
- `title` - Job title
|
|
87
|
+
- `email` - Verified email
|
|
88
|
+
- `linkedin_url` - LinkedIn profile
|
|
89
|
+
- `organization` - Company details
|
|
90
|
+
- `seniority` - Seniority level
|
|
91
|
+
- `departments` - Department list
|
|
92
|
+
|
|
93
|
+
### Organization Data
|
|
94
|
+
- `name` - Company name
|
|
95
|
+
- `website_url` - Website
|
|
96
|
+
- `estimated_num_employees` - Employee count
|
|
97
|
+
- `industry` - Industry
|
|
98
|
+
- `annual_revenue` - Revenue
|
|
99
|
+
- `technologies` - Tech stack
|
|
100
|
+
- `funding_total` - Total funding
|
|
101
|
+
|
|
102
|
+
## Parameters
|
|
103
|
+
|
|
104
|
+
### People Search
|
|
105
|
+
- `person_titles` - Array of job titles
|
|
106
|
+
- `person_locations` - Array of locations
|
|
107
|
+
- `person_seniorities` - Array: owner, founder, c_suite, partner, vp, head, director, manager, senior, entry
|
|
108
|
+
- `organization_num_employees_ranges` - Array of ranges (e.g., "1,100")
|
|
109
|
+
- `organization_ids` - Filter by Apollo org IDs
|
|
110
|
+
- `page` - Page number (default: 1)
|
|
111
|
+
- `per_page` - Results per page (default: 25, max: 100)
|
|
112
|
+
|
|
113
|
+
### Person Enrichment
|
|
114
|
+
- `email` - Email address
|
|
115
|
+
- `first_name` + `last_name` + `domain` - Alternative lookup
|
|
116
|
+
- `linkedin_url` - LinkedIn URL
|
|
117
|
+
- `reveal_personal_emails` - Include personal emails
|
|
118
|
+
- `reveal_phone_number` - Include phone numbers
|
|
119
|
+
|
|
120
|
+
### Organization Search
|
|
121
|
+
- `organization_locations` - Array of locations
|
|
122
|
+
- `organization_num_employees_ranges` - Employee count ranges
|
|
123
|
+
- `organization_ids` - Specific org IDs
|
|
124
|
+
- `page` - Page number
|
|
125
|
+
|
|
126
|
+
## When to Use
|
|
127
|
+
|
|
128
|
+
- Building targeted prospect lists by role, seniority, and company size
|
|
129
|
+
- Enriching leads with verified contact info
|
|
130
|
+
- Finding decision-makers at target accounts
|
|
131
|
+
- Company research and firmographic analysis
|
|
132
|
+
- ABM campaign targeting
|
|
133
|
+
- Sales intelligence and outbound prospecting
|
|
134
|
+
|
|
135
|
+
## Rate Limits
|
|
136
|
+
|
|
137
|
+
- Rate limits vary by plan
|
|
138
|
+
- Standard: 100 requests/minute for most endpoints
|
|
139
|
+
- Bulk enrichment: up to 10 people per request
|
|
140
|
+
- Search: max 50,000 records (100 per page, 500 pages)
|
|
141
|
+
|
|
142
|
+
## Relevant Skills
|
|
143
|
+
|
|
144
|
+
- abm-strategy
|
|
145
|
+
- lead-enrichment
|
|
146
|
+
- lead-scoring
|
|
147
|
+
- cold-email
|
|
148
|
+
- competitor-alternatives
|
|
@@ -0,0 +1,157 @@
|
|
|
1
|
+
# Beehiiv
|
|
2
|
+
|
|
3
|
+
Newsletter platform with subscriber management, post publishing, automations, and referral programs.
|
|
4
|
+
|
|
5
|
+
## Capabilities
|
|
6
|
+
|
|
7
|
+
| Integration | Available | Notes |
|
|
8
|
+
|-------------|-----------|-------|
|
|
9
|
+
| API | ✓ | REST API v2 for publications, subscriptions, posts, segments |
|
|
10
|
+
| MCP | - | Not available |
|
|
11
|
+
| CLI | ✓ | [beehiiv.js](../clis/beehiiv.js) |
|
|
12
|
+
| SDK | - | No official SDK; OpenAPI spec available for codegen |
|
|
13
|
+
|
|
14
|
+
## Authentication
|
|
15
|
+
|
|
16
|
+
- **Type**: Bearer Token
|
|
17
|
+
- **Header**: `Authorization: Bearer {api_key}`
|
|
18
|
+
- **Get key**: Settings > API under Workspace Settings at https://app.beehiiv.com
|
|
19
|
+
- **Note**: API key is only shown once on creation; copy and store it immediately
|
|
20
|
+
|
|
21
|
+
## Common Agent Operations
|
|
22
|
+
|
|
23
|
+
### List publications
|
|
24
|
+
|
|
25
|
+
```bash
|
|
26
|
+
GET https://api.beehiiv.com/v2/publications
|
|
27
|
+
```
|
|
28
|
+
|
|
29
|
+
### Get publication details
|
|
30
|
+
|
|
31
|
+
```bash
|
|
32
|
+
GET https://api.beehiiv.com/v2/publications/{publicationId}
|
|
33
|
+
```
|
|
34
|
+
|
|
35
|
+
### List subscriptions
|
|
36
|
+
|
|
37
|
+
```bash
|
|
38
|
+
GET https://api.beehiiv.com/v2/publications/{publicationId}/subscriptions?limit=10&status=active
|
|
39
|
+
|
|
40
|
+
# Filter by email
|
|
41
|
+
GET https://api.beehiiv.com/v2/publications/{publicationId}/subscriptions?email=user@example.com
|
|
42
|
+
```
|
|
43
|
+
|
|
44
|
+
### Create subscription
|
|
45
|
+
|
|
46
|
+
```bash
|
|
47
|
+
POST https://api.beehiiv.com/v2/publications/{publicationId}/subscriptions
|
|
48
|
+
|
|
49
|
+
{
|
|
50
|
+
"email": "user@example.com",
|
|
51
|
+
"reactivate_existing": false,
|
|
52
|
+
"send_welcome_email": true,
|
|
53
|
+
"utm_source": "api",
|
|
54
|
+
"tier": "free"
|
|
55
|
+
}
|
|
56
|
+
```
|
|
57
|
+
|
|
58
|
+
### Update subscription
|
|
59
|
+
|
|
60
|
+
```bash
|
|
61
|
+
PUT https://api.beehiiv.com/v2/publications/{publicationId}/subscriptions/{subscriptionId}
|
|
62
|
+
|
|
63
|
+
{
|
|
64
|
+
"tier": "premium"
|
|
65
|
+
}
|
|
66
|
+
```
|
|
67
|
+
|
|
68
|
+
### Delete subscription
|
|
69
|
+
|
|
70
|
+
```bash
|
|
71
|
+
DELETE https://api.beehiiv.com/v2/publications/{publicationId}/subscriptions/{subscriptionId}
|
|
72
|
+
```
|
|
73
|
+
|
|
74
|
+
### List posts
|
|
75
|
+
|
|
76
|
+
```bash
|
|
77
|
+
GET https://api.beehiiv.com/v2/publications/{publicationId}/posts?limit=10&status=confirmed
|
|
78
|
+
```
|
|
79
|
+
|
|
80
|
+
### Create post (Enterprise only)
|
|
81
|
+
|
|
82
|
+
```bash
|
|
83
|
+
POST https://api.beehiiv.com/v2/publications/{publicationId}/posts
|
|
84
|
+
|
|
85
|
+
{
|
|
86
|
+
"title": "Weekly Update",
|
|
87
|
+
"subtitle": "What happened this week",
|
|
88
|
+
"content": "<p>Hello subscribers...</p>",
|
|
89
|
+
"status": "draft"
|
|
90
|
+
}
|
|
91
|
+
```
|
|
92
|
+
|
|
93
|
+
### List segments
|
|
94
|
+
|
|
95
|
+
```bash
|
|
96
|
+
GET https://api.beehiiv.com/v2/publications/{publicationId}/segments
|
|
97
|
+
```
|
|
98
|
+
|
|
99
|
+
### List automations
|
|
100
|
+
|
|
101
|
+
```bash
|
|
102
|
+
GET https://api.beehiiv.com/v2/publications/{publicationId}/automations
|
|
103
|
+
```
|
|
104
|
+
|
|
105
|
+
### Get referral program
|
|
106
|
+
|
|
107
|
+
```bash
|
|
108
|
+
GET https://api.beehiiv.com/v2/publications/{publicationId}/referral_program
|
|
109
|
+
```
|
|
110
|
+
|
|
111
|
+
## API Pattern
|
|
112
|
+
|
|
113
|
+
All endpoints are scoped to a publication. The publication ID is a required path parameter for most operations. Responses use cursor-based pagination with a `cursor` parameter for fetching subsequent pages.
|
|
114
|
+
|
|
115
|
+
## Key Metrics
|
|
116
|
+
|
|
117
|
+
### Subscription Fields
|
|
118
|
+
- `status` - validating, invalid, pending, active, inactive
|
|
119
|
+
- `tier` - free or premium
|
|
120
|
+
- `created` - Subscription creation timestamp
|
|
121
|
+
- `utm_source`, `utm_medium`, `utm_campaign` - Acquisition tracking
|
|
122
|
+
- `referral_code` - Unique referral code for subscriber
|
|
123
|
+
|
|
124
|
+
### Post Fields
|
|
125
|
+
- `status` - draft, confirmed (scheduled), archived
|
|
126
|
+
- `publish_date` - When the post was/will be published
|
|
127
|
+
- `stats` - Open rate, click rate, subscriber count (with expand)
|
|
128
|
+
|
|
129
|
+
## Parameters
|
|
130
|
+
|
|
131
|
+
### Common Query Parameters
|
|
132
|
+
- `limit` - Results per page (1-100, default 10)
|
|
133
|
+
- `cursor` - Cursor for next page of results
|
|
134
|
+
- `expand[]` - Include additional data: stats, custom_fields, referrals
|
|
135
|
+
- `status` - Filter by subscription/post status
|
|
136
|
+
- `tier` - Filter by subscription tier (free, premium)
|
|
137
|
+
|
|
138
|
+
## When to Use
|
|
139
|
+
|
|
140
|
+
- Managing newsletter subscribers programmatically
|
|
141
|
+
- Syncing subscribers from external signup forms or landing pages
|
|
142
|
+
- Building referral program integrations
|
|
143
|
+
- Automating post creation and publishing workflows
|
|
144
|
+
- Tracking subscriber growth and engagement metrics
|
|
145
|
+
|
|
146
|
+
## Rate Limits
|
|
147
|
+
|
|
148
|
+
- API rate limits apply per API key
|
|
149
|
+
- Use cursor-based pagination for efficient data retrieval
|
|
150
|
+
- Batch operations not available; iterate with individual requests
|
|
151
|
+
|
|
152
|
+
## Relevant Skills
|
|
153
|
+
|
|
154
|
+
- email-sequence
|
|
155
|
+
- newsletter-growth
|
|
156
|
+
- referral-program
|
|
157
|
+
- content-strategy
|
|
@@ -0,0 +1,268 @@
|
|
|
1
|
+
# Brevo
|
|
2
|
+
|
|
3
|
+
All-in-one marketing platform (formerly Sendinblue) for email, SMS, and WhatsApp with contacts, campaigns, and transactional messaging.
|
|
4
|
+
|
|
5
|
+
## Capabilities
|
|
6
|
+
|
|
7
|
+
| Integration | Available | Notes |
|
|
8
|
+
|-------------|-----------|-------|
|
|
9
|
+
| API | ✓ | REST API v3 for contacts, campaigns, transactional email/SMS |
|
|
10
|
+
| MCP | - | Not available |
|
|
11
|
+
| CLI | ✓ | [brevo.js](../clis/brevo.js) |
|
|
12
|
+
| SDK | ✓ | Node.js, Python, PHP, Ruby, Java, C#, Go |
|
|
13
|
+
|
|
14
|
+
## Authentication
|
|
15
|
+
|
|
16
|
+
- **Type**: API Key
|
|
17
|
+
- **Header**: `api-key: {api_key}`
|
|
18
|
+
- **Get key**: SMTP & API settings at https://app.brevo.com/settings/keys/api
|
|
19
|
+
- **Note**: API key is only shown once on creation; store securely. Formerly used `api.sendinblue.com` base URL.
|
|
20
|
+
|
|
21
|
+
## Common Agent Operations
|
|
22
|
+
|
|
23
|
+
### Get account info
|
|
24
|
+
|
|
25
|
+
```bash
|
|
26
|
+
GET https://api.brevo.com/v3/account
|
|
27
|
+
```
|
|
28
|
+
|
|
29
|
+
### List contacts
|
|
30
|
+
|
|
31
|
+
```bash
|
|
32
|
+
GET https://api.brevo.com/v3/contacts?limit=50&offset=0
|
|
33
|
+
```
|
|
34
|
+
|
|
35
|
+
### Get contact by email
|
|
36
|
+
|
|
37
|
+
```bash
|
|
38
|
+
GET https://api.brevo.com/v3/contacts/user@example.com
|
|
39
|
+
```
|
|
40
|
+
|
|
41
|
+
### Create contact
|
|
42
|
+
|
|
43
|
+
```bash
|
|
44
|
+
POST https://api.brevo.com/v3/contacts
|
|
45
|
+
|
|
46
|
+
{
|
|
47
|
+
"email": "user@example.com",
|
|
48
|
+
"attributes": {
|
|
49
|
+
"FIRSTNAME": "Jane",
|
|
50
|
+
"LASTNAME": "Doe"
|
|
51
|
+
},
|
|
52
|
+
"listIds": [1, 2]
|
|
53
|
+
}
|
|
54
|
+
```
|
|
55
|
+
|
|
56
|
+
### Update contact
|
|
57
|
+
|
|
58
|
+
```bash
|
|
59
|
+
PUT https://api.brevo.com/v3/contacts/user@example.com
|
|
60
|
+
|
|
61
|
+
{
|
|
62
|
+
"attributes": {
|
|
63
|
+
"FIRSTNAME": "Updated"
|
|
64
|
+
},
|
|
65
|
+
"listIds": [3]
|
|
66
|
+
}
|
|
67
|
+
```
|
|
68
|
+
|
|
69
|
+
### Delete contact
|
|
70
|
+
|
|
71
|
+
```bash
|
|
72
|
+
DELETE https://api.brevo.com/v3/contacts/user@example.com
|
|
73
|
+
```
|
|
74
|
+
|
|
75
|
+
### Import contacts
|
|
76
|
+
|
|
77
|
+
```bash
|
|
78
|
+
POST https://api.brevo.com/v3/contacts/import
|
|
79
|
+
|
|
80
|
+
{
|
|
81
|
+
"jsonBody": [
|
|
82
|
+
{ "email": "user1@example.com" },
|
|
83
|
+
{ "email": "user2@example.com" }
|
|
84
|
+
],
|
|
85
|
+
"listIds": [1]
|
|
86
|
+
}
|
|
87
|
+
```
|
|
88
|
+
|
|
89
|
+
### List contact lists
|
|
90
|
+
|
|
91
|
+
```bash
|
|
92
|
+
GET https://api.brevo.com/v3/contacts/lists?limit=50&offset=0
|
|
93
|
+
```
|
|
94
|
+
|
|
95
|
+
### Create list
|
|
96
|
+
|
|
97
|
+
```bash
|
|
98
|
+
POST https://api.brevo.com/v3/contacts/lists
|
|
99
|
+
|
|
100
|
+
{
|
|
101
|
+
"name": "Newsletter Subscribers",
|
|
102
|
+
"folderId": 1
|
|
103
|
+
}
|
|
104
|
+
```
|
|
105
|
+
|
|
106
|
+
### Add contacts to list
|
|
107
|
+
|
|
108
|
+
```bash
|
|
109
|
+
POST https://api.brevo.com/v3/contacts/lists/{listId}/contacts/add
|
|
110
|
+
|
|
111
|
+
{
|
|
112
|
+
"emails": ["user1@example.com", "user2@example.com"]
|
|
113
|
+
}
|
|
114
|
+
```
|
|
115
|
+
|
|
116
|
+
### Remove contacts from list
|
|
117
|
+
|
|
118
|
+
```bash
|
|
119
|
+
POST https://api.brevo.com/v3/contacts/lists/{listId}/contacts/remove
|
|
120
|
+
|
|
121
|
+
{
|
|
122
|
+
"emails": ["user1@example.com"]
|
|
123
|
+
}
|
|
124
|
+
```
|
|
125
|
+
|
|
126
|
+
### Send transactional email
|
|
127
|
+
|
|
128
|
+
```bash
|
|
129
|
+
POST https://api.brevo.com/v3/smtp/email
|
|
130
|
+
|
|
131
|
+
{
|
|
132
|
+
"sender": {
|
|
133
|
+
"name": "My App",
|
|
134
|
+
"email": "noreply@example.com"
|
|
135
|
+
},
|
|
136
|
+
"to": [
|
|
137
|
+
{ "email": "user@example.com", "name": "Jane Doe" }
|
|
138
|
+
],
|
|
139
|
+
"subject": "Order Confirmation",
|
|
140
|
+
"htmlContent": "<html><body><p>Your order is confirmed.</p></body></html>"
|
|
141
|
+
}
|
|
142
|
+
```
|
|
143
|
+
|
|
144
|
+
### List email campaigns
|
|
145
|
+
|
|
146
|
+
```bash
|
|
147
|
+
GET https://api.brevo.com/v3/emailCampaigns?limit=50&offset=0&type=classic&status=sent
|
|
148
|
+
```
|
|
149
|
+
|
|
150
|
+
### Create email campaign
|
|
151
|
+
|
|
152
|
+
```bash
|
|
153
|
+
POST https://api.brevo.com/v3/emailCampaigns
|
|
154
|
+
|
|
155
|
+
{
|
|
156
|
+
"name": "January Newsletter",
|
|
157
|
+
"subject": "Monthly Update",
|
|
158
|
+
"sender": { "name": "My Brand", "email": "news@example.com" },
|
|
159
|
+
"htmlContent": "<html><body><p>Newsletter content</p></body></html>",
|
|
160
|
+
"recipients": { "listIds": [1, 2] }
|
|
161
|
+
}
|
|
162
|
+
```
|
|
163
|
+
|
|
164
|
+
### Send campaign immediately
|
|
165
|
+
|
|
166
|
+
```bash
|
|
167
|
+
POST https://api.brevo.com/v3/emailCampaigns/{campaignId}/sendNow
|
|
168
|
+
```
|
|
169
|
+
|
|
170
|
+
### Send test email for campaign
|
|
171
|
+
|
|
172
|
+
```bash
|
|
173
|
+
POST https://api.brevo.com/v3/emailCampaigns/{campaignId}/sendTest
|
|
174
|
+
|
|
175
|
+
{
|
|
176
|
+
"emailTo": ["test@example.com"]
|
|
177
|
+
}
|
|
178
|
+
```
|
|
179
|
+
|
|
180
|
+
### Send transactional SMS
|
|
181
|
+
|
|
182
|
+
```bash
|
|
183
|
+
POST https://api.brevo.com/v3/transactionalSMS/sms
|
|
184
|
+
|
|
185
|
+
{
|
|
186
|
+
"sender": "MyApp",
|
|
187
|
+
"recipient": "+15551234567",
|
|
188
|
+
"content": "Your verification code is 123456",
|
|
189
|
+
"type": "transactional"
|
|
190
|
+
}
|
|
191
|
+
```
|
|
192
|
+
|
|
193
|
+
### List SMS campaigns
|
|
194
|
+
|
|
195
|
+
```bash
|
|
196
|
+
GET https://api.brevo.com/v3/smsCampaigns?limit=50&offset=0
|
|
197
|
+
```
|
|
198
|
+
|
|
199
|
+
### List senders
|
|
200
|
+
|
|
201
|
+
```bash
|
|
202
|
+
GET https://api.brevo.com/v3/senders
|
|
203
|
+
```
|
|
204
|
+
|
|
205
|
+
## API Pattern
|
|
206
|
+
|
|
207
|
+
Brevo uses standard REST with offset-based pagination (`limit` and `offset` parameters). Contact attributes use uppercase field names (FIRSTNAME, LASTNAME). Lists are nested under the contacts resource path. Transactional email uses the `/smtp/email` endpoint despite being REST-based.
|
|
208
|
+
|
|
209
|
+
## Key Metrics
|
|
210
|
+
|
|
211
|
+
### Contact Fields
|
|
212
|
+
- `email` - Email address
|
|
213
|
+
- `attributes` - Custom attributes (FIRSTNAME, LASTNAME, SMS, etc.)
|
|
214
|
+
- `listIds` - Associated list IDs
|
|
215
|
+
- `emailBlacklisted` - Email opt-out status
|
|
216
|
+
- `smsBlacklisted` - SMS opt-out status
|
|
217
|
+
- `statistics` - Engagement stats (with expand)
|
|
218
|
+
|
|
219
|
+
### Campaign Metrics
|
|
220
|
+
- `sent` - Total sends
|
|
221
|
+
- `delivered` - Successful deliveries
|
|
222
|
+
- `openRate` - Open percentage
|
|
223
|
+
- `clickRate` - Click percentage
|
|
224
|
+
- `unsubscribed` - Unsubscribe count
|
|
225
|
+
- `hardBounces`, `softBounces` - Bounce counts
|
|
226
|
+
|
|
227
|
+
### Transactional Email Response
|
|
228
|
+
- `messageId` - Unique message identifier for tracking
|
|
229
|
+
|
|
230
|
+
## Parameters
|
|
231
|
+
|
|
232
|
+
### Contact Parameters
|
|
233
|
+
- `email` - Contact email address
|
|
234
|
+
- `attributes` - Key-value object of custom attributes
|
|
235
|
+
- `listIds` - Array of list IDs to subscribe to
|
|
236
|
+
- `unlinkListIds` - Array of list IDs to unsubscribe from
|
|
237
|
+
|
|
238
|
+
### Campaign Parameters
|
|
239
|
+
- `name` - Campaign name
|
|
240
|
+
- `subject` - Email subject line
|
|
241
|
+
- `sender` - Object with `name` and `email`
|
|
242
|
+
- `htmlContent` / `textContent` - Email body
|
|
243
|
+
- `recipients` - Object with `listIds` array
|
|
244
|
+
- `type` - classic or trigger
|
|
245
|
+
|
|
246
|
+
## When to Use
|
|
247
|
+
|
|
248
|
+
- Multi-channel marketing (email + SMS + WhatsApp)
|
|
249
|
+
- Transactional email sending with tracking
|
|
250
|
+
- Managing contacts and segmented lists
|
|
251
|
+
- Creating and scheduling email campaigns
|
|
252
|
+
- SMS notifications and marketing
|
|
253
|
+
- Affordable all-in-one marketing automation
|
|
254
|
+
|
|
255
|
+
## Rate Limits
|
|
256
|
+
|
|
257
|
+
- API rate limits depend on plan (free tier: limited sends/day)
|
|
258
|
+
- Transactional email: varies by plan
|
|
259
|
+
- Contact imports: batch processing with async status
|
|
260
|
+
- Rate limit headers returned with responses
|
|
261
|
+
|
|
262
|
+
## Relevant Skills
|
|
263
|
+
|
|
264
|
+
- email-sequence
|
|
265
|
+
- sms-marketing
|
|
266
|
+
- transactional-email
|
|
267
|
+
- lifecycle-marketing
|
|
268
|
+
- contact-management
|