Sendy API

Sendy's API is based on simple HTTP POST. Use the API to integrate Sendy programmatically with your website or application. Some APIs may require the latest version of Sendy (currently version 3.0.7). We're working to include more APIs.

This method adds a new subscriber to a list. You can also use this method to update an existing subscriber. On another note, you can also embed a subscribe form on your website using Sendy's subscribe form HTML code. Visit View all lists, select your desired list then click 'Subscribe form' at the top of the page.

URL
http://your_sendy_installation/subscribe

PARAMETERS (POST)

Note: You can also pass values into custom fields. To add values to your desired custom field, use the personalization tag of the custom field as the parameter. Say, your custom field tag is [Birthday,fallback=], you can use the parameter, 'Birthday' to add values to this custom field.

name user's name (optional)
email user's email
list the list id you want to subscribe a user to. This encrypted & hashed id can be found under View all lists section named ID.
country user's 2 letter country code (optional)
ipaddress user's IP address (optional)
referrer the URL where the user signed up from (optional)
gdpr if you're signing up EU users in a GDPR compliant manner, set this to "true" (optional)
hp include this 'honeypot' field to prevent spambots from signing up via this API call. When spambots fills in this field, this API call will exit, preventing them from signing up fake addresses to your form. This parameter is only supported in Sendy 3.0 onwards. (optional)
boolean set this to "true" so that you'll get a plain text response (optional)

RESPONSE (Plain text)

Success: true

Error: Some fields are missing.

Error: Invalid email address.

Error: Invalid list ID.

Error: Already subscribed.

Unsubscribe

This method unsubscribes a user from a list.

URL
http://your_sendy_installation/unsubscribe

PARAMETERS (POST)

email user's email
list the list id you want to unsubscribe a user from. This encrypted & hashed id can be found under View all lists section named ID
boolean set this to "true" so that you'll get a plain text response

RESPONSE (Plain text)

Success: true

Error: Some fields are missing.

Error: Invalid email address.

Delete subscriber

This method deletes a subscriber off a list (only supported in Sendy version 2.1.1.4 and above).

URL
http://your_sendy_installation/api/subscribers/delete.php

PARAMETERS (POST)

api_key your API key, available in Settings.
list_id the id of the list you want to delete the subscriber from. This encrypted id can be found under View all lists section named ID
email the email address you want to delete

RESPONSE (Plain text)

Success: true

Error: No data passed

Error: API key not passed

Error: Invalid API key

Error: List ID not passed

Error: List does not exist

Error: Email address not passed

Error: Subscriber does not exist

Subscription status

This method gets the current status of a subscriber (eg. subscribed, unsubscribed, bounced, complained).

URL
http://your_sendy_installation/api/subscribers/subscription-status.php

PARAMETERS (POST)

api_key your API key, available in Settings.
email user's email
list_id the id of the list this email belongs to. This encrypted id can be found under View all lists section named ID

RESPONSE (Plain text)

Success: Subscribed

Success: Unsubscribed

Success: Unconfirmed

Success: Bounced

Success: Soft bounced

Success: Complained

Error: No data passed

Error: API key not passed

Error: Invalid API key

Error: Email not passed

Error: List ID not passed

Error: Email does not exist in list

Active subscriber count

This method gets the total active subscriber count of a list.

URL
http://your_sendy_installation/api/subscribers/active-subscriber-count.php

PARAMETERS (POST)

api_key your API key, available in Settings.
list_id the id of the list you want to get the active subscriber count. This encrypted id can be found under View all lists section named ID

RESPONSE (Plain text)

Success: You'll get an integer of the active subscriber count

Error: No data passed

Error: API key not passed

Error: Invalid API key

Error: List ID not passed

Error: List does not exist

Create and send campaign

This method creates a campaign (with an option to send it too).

Important note: You must have a cron job setup for sending in order for your campaign to be sent via this API. The cron job setup instructions can be found at the 'Define recipients' page (the page where you choose lists to send your campaign to) in a blue box at the bottom.

URL
http://your_sendy_installation/api/campaigns/create.php

PARAMETERS (POST)

api_key your API key, available in Settings.
from_name the 'From name' of your campaign
from_email the 'From email' of your campaign
reply_to the 'Reply to' of your campaign
title the 'Title' of your campaign
subject the 'Subject' of your campaign
plain_text the 'Plain text version' of your campaign (optional)
html_text the 'HTML version' of your campaign
list_ids Required only if you set send_campaign to 1 and no segment_ids are passed in. List IDs should be single or comma-separated. The encrypted & hashed ids can be found under View all lists section named ID.
segment_ids Required only if you set send_campaign to 1 and no list_ids are passed in. Segment IDs should be single or comma-separated. Segment ids can be found in the segments setup page.
exclude_list_ids Lists to exclude from your campaign. List IDs should be single or comma-separated. The encrypted & hashed ids can be found under View all lists section named ID. (optional)
exclude_segments_ids Segments to exclude from your campaign. Segment IDs should be single or comma-separated. Segment ids can be found in the segments setup page. (optional)
brand_id Required only if you are creating a 'Draft' campaign (send_campaign set to 0 or left as default). Brand IDs can be found under 'Brands' page named ID
query_string eg. Google Analytics tags (optional)
send_campaign Set to 1 if you want to send the campaign as well and not just create a draft. Default is 0.

RESPONSE (Plain text)

Success: Campaign created

Success: Campaign created and now sending

Error: No data passed

Error: API key not passed

Error: Invalid API key

Error: From name not passed

Error: From email not passed

Error: Reply to email not passed

Error: Subject not passed

Error: HTML not passed

Error: List or segment ID(s) not passed

Error: One or more list IDs are invalid

Error: One or more segment IDs are invalid

Error: List or segment IDs does not belong to a single brand

Error: Brand ID not passed

Error: Unable to create campaign

Error: Unable to create and send campaign

Error: Unable to calculate totals

Sendy API Examples

Below are some example scripts you can download to get an idea about how Sendy's API can be used. On another note, Sendy also provides you with a subscribe form HTML code for every list which you can readily use. Just visit any list and click 'Subscribe form' at the top right.

Simple subscribe → Download

An example on how to use the Subscribe API to add subscribers to a list in Sendy.

Subscribe via AJAX → Download

An example on how to use the Subscribe API to add subscribers to a list in Sendy via AJAX.

Subscribe to multiple lists → Download

An example on how to use the Subscribe API to add subscribers to multiple lists in Sendy. The user will be able to choose from whichever list(s) to subscribe to.

Get active subscriber count for a list → Download

An example on how to use the Active subscriber count API to get the active subscriber count for a particular list.

Get subscription status of an email in a list → Download

An example on how to use the Subscription status API to get the subscription status of a subscriber in a particular list.

Third Party Resources & Integrations

Zapier

Sendy + Zapier Integration

Zapier's integration with Sendy opens up a whole world of automation! You can integrate Sendy with 1000+ apps available in Zapier's app directory.

On the right are a few ready to use "Zaps" to get you started! Alternatively you can visit Zapier and create your own "Zaps" to integrate Sendy with any other apps.

You'd be prompted to signup for a free Zapier account if you don't have one.

Check out Sendy on Zapier

Wordpress plugins

Convert Pro integration

Convert Pro is a feature rich email opt-in & lead generation plugin. Easily create fast loading and mobile friendly sign up forms with a drag & drop editor.

Sendy Wordpress plugin

This Wordpress plugin provides an easy, lightweight way to let your users subscribe to a list in Sendy.

Ninja Popups for WordPress

A very popular and feature rich popup signup form plugin for Wordpress.

Techsarathy Sendy Contact Form 7 Integration

Sendy integration for Contact Form 7.

Sendy-WPCF (Wordpress plugin for Contact Form 7)

Lightweight Contact Form 7 plugin for Wordpress that integrates with Sendy.

Bloom Sendy Integration Addon

Bloom Sendy Integration Addon is a WordPress plugin that allows you to seamlessly integrate ElegantThemes' Bloom email opt-in plugin for WordPress with Sendy newsletter application.

Gravity Forms Sendy Addon

Gravity Forms Sendy Addon lets you subscribe users using Gravity Forms.

OptinMonster Integration Addon

OptinMonster Sendy Integration Addon is a WordPress plugin that allows you to seamlessly integrate Sendy with OptinMonster.

Opt-In Panda for Wordpress

Opt-In Panda locks a portion of content on a webpage, by hiding or blurring it, and asks the visitor to enter his email address (opt-in) to unlock your content. Integrates with Sendy.

WP Subscribe Pro from MyThemeShop

List building tool that easily integrates with Sendy for capturing subscriber data and growing your email list.

Sendy Widget Pro

This AJAX Wordpress plugin supports subscription to one or multiple lists. Features includes validation of user input before subscribing, subscriber count in front end of widget etc.

Layered Popups for WordPress

This Wordpress plugin lets you easily create stunning signup form pop-ups. Lots of options to choose from. Integrates with Sendy.

Sync to Sendy

This plugin allows you to subscribe users to your Sendy list when they register.

ConvertPlus

ConvertPlus is a Wordpress plugin that allows you to create beautiful elements such as Info Bar, Modal Popup, Slide In, Opt-in Widget, etc that call users for action and help you convert more visitors.

Hustle

A Wordpress plugin that lets you create pop-ups, slide-ins & in-content opt-in forms on your Wordpress site. Lets you subscribe users to a Sendy list.

Total Support Widget

The Total Support Widget gives you Patreon, 20 social & support links, and Sendy or Mailchimp signup.

MemberPress Integration

Integration between MemberPress Wordpress plugin and Sendy.

SeedProd integration ('Coming Soon Page' plugin for WordPress)

Enables subscribing of users to your Sendy list with SeedProd Wordpress plugin.

Multilist Subscribe for Sendy

Multilist Subscribe for Sendy integrates WordPress post notifications into one or more of your Sendy email marketing campaigns.

eForm - WordPress Form Builder

eForm is a premium Wordpress form builder plugin for complete form management solution, quizzes, surveys, data collection, payment / cost estimation and user feedback of all kinds.

MailOptin integration with Sendy

MailOptin is a Wordpress plugin that allows you to create opt-in forms to capture email addresses and save them in Sendy. It also allows you to create and send email campaigns through Sendy within your WordPress dashboard.

Magento

Sendy Newsletter Integration for Magento

Integration of Sendy with Magento.

Sendy Remote Integration for Magento

This extension is designed to remotely integrate Sendy into Magento without the need of both to be on the same server or share the same database.

Sendy Extension for Magento 2

This Magento 2 extension syncs 'subscribe' & 'unsubscribe' statuses with your Sendy list(s).

Sendy connector for Magento

Connect your Magento install to your Sendy install without both being on the same server.

Capture & Create email campaigns from Magento

2-way subscribers management with ability to send email campaigns right in your Magento admin.

Drupal

Nitro Sendy for Drupal

This Drupal 7 module allows visitors to subscribe to lists in Sendy and automatically sends published articles as newsletters.

Sendy Module for Drupal

This is a Sendy module for Drupal 7. Capture email addresses of website visitors and maintain an email marketing list of registered users.

Joomla

Joomla Extension for Sendy

This Sendy extension for Joomla features 'Easy Newsletter signup module', 'User registration newsletter signup' and 'Easy API for adding users to or removing users from a list from any other extension'.

Woocommerce

WooCommerce Sendy

"WooCommerce Sendy" provides simple and flexible Sendy integration for WooCommerce. It can be used to show a checkbox on checkout page for subscription or automatically subscribe users to Sendy list after checkout.

WooCommerce Product to Sendy List

This plugin for WooCommerce allows you to auto subscribe customers to your Sendy mailing lists after they have purchased particular products.

Prestashop

Sendy Prestashop newsletter module by Hélder Pestana

This module is based on Prestashop's block newsletter module, modified to include the possibility of automatically subscribing users to a given Sendy newsletter. It retains all the functionality of the default newsletter module.

Sendy Prestashop newsletter module by iztoksvetik

This module is similar to Prestashop's native newsletter module. The big difference is that this module saves subscribers directly to your Sendy installation.