mirror of
https://github.com/warmbly/warmbly.git
synced 2026-08-24 16:00:39 +00:00
Matthew Meszaros
3236ffc459
Restructure the docs navigation into product-focused pages, add automation expression reference content, and refresh related template and personalization surfaces.
93 lines
3.0 KiB
Plaintext
93 lines
3.0 KiB
Plaintext
---
|
|
title: Introduction
|
|
description: Guides and reference for Warmbly — email warmup, cold outreach, and CRM.
|
|
---
|
|
|
|
# Warmbly Documentation
|
|
|
|
Warmbly is an email warmup and cold outreach platform. It manages your sender mailboxes, warms them up to build reputation, sends campaigns safely across many mailboxes, and tracks replies, deliverability, and your pipeline in one place. These guides walk through every part of the product, followed by the API reference.
|
|
|
|
## Guides
|
|
|
|
<Cards>
|
|
<Card title="Mailboxes" href="/mailboxes">
|
|
Connect sender accounts and set per-mailbox sending limits.
|
|
</Card>
|
|
<Card title="Warmup" href="/warmup">
|
|
Build sender reputation with gradual, spaced warmup traffic.
|
|
</Card>
|
|
<Card title="Campaigns" href="/campaigns">
|
|
Create and send cold outreach safely, within the guardrails.
|
|
</Card>
|
|
<Card title="Sequences & steps" href="/sequences">
|
|
Follow-ups, A/B variants, and reply branching.
|
|
</Card>
|
|
<Card title="Personalization & expressions" href="/expressions">
|
|
Merge fields, conditionals, functions, fallbacks, and spintax.
|
|
</Card>
|
|
<Card title="Deliverability" href="/deliverability">
|
|
Bounce, complaint, and inbox-placement health.
|
|
</Card>
|
|
<Card title="Contacts & CRM" href="/contacts-crm">
|
|
Import contacts, custom fields, deals, and pipelines.
|
|
</Card>
|
|
<Card title="Unibox" href="/unibox">
|
|
A unified inbox across all your connected mailboxes.
|
|
</Card>
|
|
<Card title="Automations" href="/automations">
|
|
Trigger-based flows that act across your integrations.
|
|
</Card>
|
|
<Card title="Integrations" href="/integrations">
|
|
Connect third-party tools over OAuth and webhooks.
|
|
</Card>
|
|
<Card title="Meetings" href="/meetings">
|
|
Calendly and Cal.com scheduling, booking links, and timelines.
|
|
</Card>
|
|
<Card title="Analytics" href="/analytics">
|
|
Campaign and account performance metrics.
|
|
</Card>
|
|
<Card title="Notifications" href="/notifications">
|
|
The in-app feed and per-category preferences.
|
|
</Card>
|
|
<Card title="Security" href="/security">
|
|
Two-factor authentication, passkeys, and sessions.
|
|
</Card>
|
|
<Card title="Team & roles" href="/team-roles">
|
|
Invite members and control access with roles.
|
|
</Card>
|
|
</Cards>
|
|
|
|
## Using the API
|
|
|
|
The Warmbly API uses Bearer token authentication. Create a key in your dashboard under Settings, then include it on every request:
|
|
|
|
```bash
|
|
curl -X GET "https://api.warmbly.com/campaigns" \
|
|
-H "Authorization: Bearer wmbly_your_api_key_here" \
|
|
-H "Content-Type: application/json"
|
|
```
|
|
|
|
List endpoints return a consistent `data` plus `pagination` shape:
|
|
|
|
```json
|
|
{
|
|
"data": [],
|
|
"pagination": { "has_more": false, "next_cursor": null }
|
|
}
|
|
```
|
|
|
|
<Cards>
|
|
<Card title="Authentication" href="/authentication">
|
|
API key format, permissions, and security.
|
|
</Card>
|
|
<Card title="Permissions" href="/permissions">
|
|
Every API permission and what it grants.
|
|
</Card>
|
|
<Card title="Endpoints" href="/endpoints">
|
|
The full endpoint reference.
|
|
</Card>
|
|
<Card title="Error codes" href="/error-codes">
|
|
Stable machine-readable error codes.
|
|
</Card>
|
|
</Cards>
|