canonical: https://jentic.com/apis/outreachbin.com/outreachbin # OutReachBin API OutReachBin is an email outreach campaign management platform designed for cold email and lead nurturing workflows. The API provides endpoints for user authentication, campaign creation and lifecycle management (create, start, pause, restart), SMTP and IMAP email provider configuration, message sending, webhook configuration for incoming and outgoing messages, email open tracking, reply monitoring, unsubscribe management, and campaign reporting. Use it to automate cold email campaigns, integrate custom SMTP/IMAP providers, track email engagement, and pull performance reports programmatically. ## For AI agents Manage OutReachBin cold email campaigns, email providers, messaging, webhooks, tracking, and reporting for automated outreach workflows. ## Scope Does not handle DNS configuration, domain warming, or email deliverability reputation management - use for campaign creation, sending, tracking, and reporting only. ## Capabilities - Authenticate users with email/password and manage session tokens - Create and configure cold email campaigns with targeting and messaging - Start, pause, and restart campaigns to control sending schedules - Add recipients to campaigns via bulk email addition - Connect custom SMTP and IMAP email providers for sending and receiving - Send individual messages outside campaign workflows - Configure incoming and outgoing message webhooks for real-time notifications - Track email opens and engagement metrics per campaign - Monitor replies and manage reply threads - Retrieve unsubscribers and honor opt-out requests - Pull campaign performance reports for individual or all campaigns - Search and retrieve campaign details by ID or filters ## Use cases ### Automated Cold Email Campaign Creation Build cold email campaigns programmatically by connecting to a lead generation system or CRM. POST /create-campaign creates a new campaign with subject lines, message templates, and follow-up sequences. POST /add-emails adds recipient email addresses in bulk from lead lists. POST /start-campaign initiates sending. This allows agents to spin up campaigns dynamically based on lead scoring, industry segment, or sales triggers without manual setup. Example prompt: POST /create-campaign with campaign name, subject, and message body, then POST /add-emails with an array of recipient email addresses, and POST /start-campaign to begin sending. ### Custom SMTP/IMAP Provider Integration Connect OutReachBin campaigns to custom email providers for sending and receiving. POST /smtp-connect configures SMTP credentials for outbound messages, and POST /imap-connect sets up IMAP for reply monitoring. This enables use of private email servers, domain-specific sending addresses, or high-reputation email infrastructure instead of shared sending pools, improving deliverability and brand consistency. Example prompt: POST /smtp-connect with SMTP host, port, username, and password, then POST /imap-connect with IMAP credentials to enable reply tracking from the same inbox. ### Campaign Lifecycle Management Control campaign execution with start, pause, and restart operations. POST /start-campaign initiates sending, POST /pause-campaign halts sending mid-campaign, and POST /restart-campaign resumes from where it left off. GET /find-campaign retrieves campaign details and status. This supports dynamic campaign pacing based on real-time engagement metrics - pause low-performing campaigns, restart high-converters, or adjust sending schedules based on time-of-day analysis. Example prompt: POST /start-campaign to begin, POST /pause-campaign to halt, GET /find-campaign to check status, and POST /restart-campaign to resume sending. ### Real-Time Engagement Tracking and Webhooks Track email opens, replies, and unsubscribes in real time using webhooks and polling. POST /message-webhook-incoming and POST /message-webhook-outgoing configure webhooks for message events. GET /email-open retrieves open tracking data, GET /replies fetches reply threads, and GET /unsubscribers lists opt-outs. Integrate this data with CRMs or analytics platforms to score leads, trigger follow-ups, or remove unsubscribers automatically. Example prompt: POST /message-webhook-incoming with a webhook URL, then GET /email-open for open metrics, GET /replies for responses, and GET /unsubscribers to honor opt-outs. ### Campaign Performance Reporting Retrieve campaign performance metrics for a single campaign or across all campaigns. GET /pull-reports pulls metrics for a specific campaign, and GET /pull-reports-all aggregates data for all campaigns. Metrics include sent count, open rate, reply rate, bounce rate, and unsubscribes. Use this data to optimize subject lines, message copy, and sending schedules, or feed it into BI dashboards for sales team reporting. Example prompt: GET /pull-reports with campaign_id for a single campaign's metrics, or GET /pull-reports-all for cross-campaign analytics. Export to a dashboard or trigger automated optimizations based on thresholds. ## Key endpoints | Method | Path | Description | | --- | --- | --- | | POST | `/create-campaign` | Create a new cold email campaign | | POST | `/add-emails` | Add recipient emails to a campaign | | POST | `/start-campaign` | Start sending a campaign | | POST | `/pause-campaign` | Pause an active campaign | | POST | `/smtp-connect` | Configure SMTP provider for sending | | POST | `/imap-connect` | Configure IMAP provider for reply monitoring | | GET | `/pull-reports` | Retrieve campaign performance metrics | ## Key resources - **Campaigns** — Cold email campaigns with messaging, targeting, and follow-up sequences - **Email Providers** — SMTP and IMAP configurations for sending and receiving campaign messages - **Messages** — Individual messages sent within campaigns or as standalone sends - **Webhooks** — Real-time notifications for incoming and outgoing message events - **Reports** — Campaign performance metrics including opens, replies, bounces, and unsubscribes - **Replies** — Recipient responses to campaign messages - **Unsubscribers** — Recipients who opted out of campaigns ## Why Jentic - **Setup:** Wiring OutReachBin by hand means obtaining and carrying its bearer access token, connecting your own SMTP and IMAP mailboxes for sending, and managing campaign state calls yourself. Through Jentic you install once, import the OutReachBin API from the API Directory, store the access token once, and your agent calls it. - **Permission scoping:** OutReachBin identifies campaigns in the request body rather than the URL path, so scope the agent to the operations it needs, such as creating a campaign, adding emails, and pulling reports. Because you choose the allowed operations, state changes like starting or pausing a campaign are not included unless you add them. - **Credential handling:** Your OutReachBin access token and any SMTP or IMAP credentials are stored once, encrypted, by your own Jentic One instance and injected at execution time. They never enter the agent's prompt, logs, or context. - **Discovery method:** Agents search Jentic by intent such as 'create a cold email campaign' or 'track email opens', and Jentic returns the matching OutReachBin operation with its input schema so the agent calls the right endpoint without browsing the reference docs. ## Related APIs - **Instantly API** — An OutReachBin alternative for cold email outreach, with automated sending, inbox warmup, and deliverability tooling at scale. - **Reply.io API** — An OutReachBin alternative for multichannel sales engagement, automating email sequences, follow-ups, and outreach campaigns. ## FAQ ### What authentication does the OutReachBin API use? The API uses session-based authentication. POST /login with email and password returns a session token, which is included in subsequent requests. Through Jentic, session tokens are managed and refreshed automatically, keeping credentials out of agent context. ### Can I use my own SMTP server with OutReachBin? Yes. POST /smtp-connect accepts SMTP host, port, username, and password to configure a custom sending server. This allows use of private email infrastructure for better deliverability and brand alignment. ### How do I track email opens in a campaign? GET /email-open retrieves open tracking data for campaign messages. Opens are tracked via embedded pixels in HTML emails and surfaced through the API for engagement analysis. ### Can I pause a campaign and restart it later? Yes. POST /pause-campaign halts sending immediately, and POST /restart-campaign resumes from where it left off. This is useful for adjusting campaigns mid-flight or pacing sends based on engagement. ### Is the OutReachBin API free? API access is included with OutReachBin subscriptions. Pricing is based on plan tier and email volume, not API request count. ### How do I configure webhooks for incoming replies? POST /message-webhook-incoming with a webhook URL to receive real-time notifications when recipients reply to campaign messages. The webhook payload includes reply content and sender details. ### Can I limit what my agent is allowed to do with the OutReachBin API? Yes. Jentic One is self-hosted, so you run your own instance and your own rules decide which OutReachBin operations and credentials the agent may use. Because OutReachBin identifies campaigns in the request body rather than the URL path, you scope the agent to just the operations it needs, such as POST /create-campaign, POST /add-emails, and GET /pull-reports. State-changing calls like POST /start-campaign and POST /pause-campaign are not available to the agent unless you explicitly add them.