Unipile Docs: Getting Started, API Reference & V2 Guide
A practical walkthrough of Unipile docs: DSN setup, access tokens, key API endpoints, V2 migration, pricing, and how UnifyPort compares as an alternative.
Unipile Docs: A Practical Guide to Getting Started, API Endpoints, and V2 Migration
Unipile's documentation is the entry point for developers who want to integrate messaging, email, and calendar functionality into their applications without building separate connectors for every provider. The docs cover account setup, authentication, core API routes, webhook behavior, and the newer V2 platform currently in beta.
This guide walks through the most important parts of the Unipile docs so you can move from signup to a working integration faster. It also covers how Unipile compares with UnifyPort when your primary requirement is multi-channel messaging through one REST API.
What Unipile Is
Unipile Docs: Getting Started, API Reference & V2 Guide - What Unipile Is.
Unipile describes itself as an API for integrating messaging and communication channels into software applications. According to the official documentation, it supports popular platforms such as WhatsApp, LinkedIn, Instagram, and Telegram, plus email providers including Google, Microsoft, and IMAP. The roadmap mentions planned support for SMS/RCS and contacts.
The core value proposition is avoiding the complexity of building messaging functionality from scratch. Instead of maintaining separate SDKs and handling each provider's quirks, developers use one API to:
- Retrieve conversation history for a contact across providers
- Receive new messages and emails in real time through webhooks
- Send messages to existing contacts or initiate new one-to-one chats
- Invite contacts and create outreach sequences
- Fetch profile information, status relationships, and posts
Getting Started in the Unipile Docs
Unipile Docs: Getting Started, API Reference & V2 Guide - Getting Started in the Unipile Docs.
The official getting started guide outlines a short setup path. The first step is creating an account through the API Dashboard signup page. After logging in, you receive a DSN, or Data Source Name, which identifies your application's data source in API requests.
Next, you generate an access token. Both the DSN and token are required for authenticated requests. The docs recommend a practical first test: use the Accounts page in the dashboard to connect an account directly, which lets you try sending and receiving messages without writing code first.
From there, the API Reference section supports interactive testing. You enter your DSN and token, select a route, and fill in parameters to see real responses before integrating anything into your own codebase.
Quick Start Workflow
A typical first session follows this sequence:
- Sign up for a Unipile account
- Log in and copy your DSN
- Generate an access token
- Connect a test account from the dashboard
- List chats with
GET /api/v1/chats - Send a test message with
POST /api/v1/chats/:chatId/messages
The quick start video referenced in the docs covers exactly these steps: connecting a provider account, listing chats, and sending a message.
Key API Concepts in the Documentation
Unipile Docs: Getting Started, API Reference & V2 Guide - Key API Concepts in the Documentation.
DSN and Access Tokens
The DSN is the primary identifier for your Unipile data source. Every request must include it. Access tokens provide authentication and should be treated as secrets. The docs emphasize that both values must be specified when testing routes in the API Reference.
Accounts
Accounts represent connected provider identities, such as a specific LinkedIn profile, WhatsApp number, or Gmail inbox. The dashboard's Accounts page is the fastest way to connect and test an account before wiring up the programmatic account-adding flow.
Chats and Messages
The chat and message endpoints form the core of the messaging API. GET /api/v1/chats lists available conversations, while POST /api/v1/chats/:chatId/messages sends a message within a specific chat. These routes are the foundation for inbox synchronization, outreach, and notification features.
Webhooks
Unipile uses webhooks to notify your application about new messages and emails in real time. Instead of polling, your backend receives events as they happen, which is essential for responsive chat UIs and automation workflows.
Unipile V2 Documentation
The V2 welcome page is important for anyone planning a new integration. Unipile V2 is currently in beta, and the docs explicitly warn that breaking changes may occur during this phase. Some features or services may be modified, interrupted, or temporarily unavailable.
Key points from the V2 docs:
- The V2 dashboard is available at
https://dashboardv2.unipile.com - You must create a new account for V2, even if you already have a V1 account
- Existing V1 data can be migrated using the official migration guide
- The documentation selector in the top left corner switches between V1 and V2 docs
If you are building a production system, the beta status is a meaningful consideration. V1 remains the stable option unless you specifically need V2 features and accept the risk of breaking changes.
Unipile Pricing at a Glance
Pricing is based on the number of connected accounts. The Unipile website lists a starting cost of €49 / $55 per month for up to 10 connected accounts, with a free 7-day trial that includes all features and requires no credit card.
Volume pricing is degressive:
| Connected Accounts | Price per Account/Month |
|---|---|
| Up to 10 | €49 / $55 flat |
| 11 to 50 | €5.00 / $5.50 |
| 51 to 200 | €4.50 / $5.00 |
| 201 to 1000 | €4.00 / $4.50 |
| 1001 to 5000 | €3.50 / $4.00 |
| 5001+ | €3.00 / $3.50 |
Billing is based on the peak number of accounts simultaneously connected during the billing period. There is no long-term contract for the pay-as-you-go plan.
Unipile vs. UnifyPort: Choosing the Right Messaging API
Unipile and UnifyPort solve a similar problem—unifying multiple messaging channels behind one API—but they prioritize different channels and developer experiences.
Unipile's strength is breadth across communication types. It combines messaging platforms like WhatsApp, LinkedIn, Instagram, and Telegram with email and calendar providers. That makes it a strong fit for products that need inbox synchronization across both chat and email, or that rely heavily on LinkedIn outreach.
UnifyPort focuses specifically on messaging APIs for channels that include Telegram, WhatsApp, LINE, X (Twitter), Zalo, and TikTok. It normalizes provider-specific SDKs into a single REST API with standardized webhook events, HMAC-SHA256 signature verification, built-in rate limiting, retries with idempotency, and failure isolation. For teams building AI agents, CRMs, notification systems, or operations tools that need reliable multi-channel message delivery, UnifyPort's narrower focus can reduce integration overhead.
For a deeper comparison of Unipile's capabilities, pricing, and alternatives, see the Unipile platform overview. If your roadmap centers on multi-channel messaging rather than email or calendar, the multi-channel communication API guide explains what to evaluate in a unified messaging platform.
Common Questions About Unipile Docs
What is a DSN in Unipile?
A DSN, or Data Source Name, is the identifier assigned to your Unipile data source. You receive it after logging into the API Dashboard, and it must be included in every API request along with your access token.
How do I test Unipile without writing code?
The docs recommend connecting an account from the dashboard's Accounts page, then using the API Reference section interactively. You enter your DSN and token, choose a route, and fill in parameters to see live responses.
Does Unipile support webhooks?
Yes. Webhooks notify your application about new messages and emails in real time, which is the recommended way to handle incoming communication instead of polling.
Is Unipile V2 stable?
No. Unipile V2 is in beta, and the documentation warns that breaking changes may be introduced. V1 remains the stable version for production integrations unless you specifically need V2 features.
Can I migrate from Unipile V1 to V2?
Yes. The V2 docs include a migration guide. You must create a new V2 account, then follow the migration steps to move your existing V1 data.
What channels does Unipile support?
Unipile supports messaging platforms including WhatsApp, LinkedIn, Instagram, and Telegram, plus email providers such as Gmail, Outlook, and IMAP. Calendar integration is also available for Google and Microsoft.
Related reading
- Linen Pants Guide: Styles, Fabrics, Fit & Care Tips - Find the best linen pants for every occasion. Compare drawstring vs. flat front, 100% linen vs. blends, fit advice, and care tips for lasting wear.
- What Is a Voice API? A Developer's Guide to Programmable Voice - Learn what a voice API is, how programmable voice works, key features to compare, real use cases, and best practices for integrating calling into your app.
- LINE Stickers: How to Buy, Send, and Create Them - Learn how to buy, send, and create LINE stickers, from official packs to custom designs, plus tips for selling your own sticker sets.
Conclusion
The Unipile docs give developers a clear path from signup to a working messaging integration. The DSN and access token model is straightforward, the dashboard enables code-free testing, and the chat and message endpoints cover the most common use cases. The main strategic decision is whether to build on stable V1 or beta V2, and whether Unipile's email and calendar breadth matches your product needs better than a messaging-focused alternative like UnifyPort.
Start with the getting started guide, test a connected account in the dashboard, and validate webhook delivery early. Those steps will surface most integration issues before you commit to a full build.