Sendy

API documentation


Sendy API

Sendy's API is based on simple HTTP POST. Use the API to integrate Sendy programmatically with your website or application. We're working to include more APIs.


Subscribe

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 find a subscribe form code in the individual lists under View all lists section.

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.

  1. name user's name is optional
  2. email user's email
  3. 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
  4. 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.

Error: Invalid list ID.

Error: Already subscribed.

Unsubscribe

This method unsubscribes a user from a list.

URL
http://your_sendy_installation/unsubscribe


PARAMETERS (POST)

  1. email user's email
  2. 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
  3. 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.

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)

  1. api_key your API key, available in Settings.
  2. email user's email
  3. 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.

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


PARAMETERS (POST)

  1. api_key your API key, available in Settings.
  2. 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



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.



Third party resources

Sendy Wordpress plugin →

This Wordpress plugin provides an easy, lightweight way to let your users subscribe to a list in Sendy. You can use it to sign up users for several different lists by placing the widget in the sidebar. Email will be validated on form submission.

Contact Form 7 Integrations (Wordpress plugin) →

This Wordpress plugin integrates Contact Form 7 with third party applications including Sendy.

Gravity Forms Sendy Addon (Wordpress plugin) →

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

Sendy Widget Pro (Wordpress plugin) →

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

Sync to Sendy (Wordpress plugin) →

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

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

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

Sendy Newsletter Integration for Magento →

Integration of Sendy with Magento.

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.

Integrating Wufoo with Sendy →

Integrates Sendy with Wufoo using webhook.

Joomla Extension for Sendy →

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

Sendy subscriber module for Fork CMS →

This module allow to create subscriber widget for the Sendy.

Sendy extension for Ninja Forms →

Sendy extension for Ninja Forms lets you subscribe users using Ninja Forms.

Sendy PHP Library →

A PHP class built to interface with Sendy's API.

RESTful API for Sendy built with Slim →

RESTful API for Sendy built with Slim.

node.js module for Sendy API →

A node.js module for Sendy API.

Sendy.Net →

Sendy.Net is a .Net library that can be used to interact with Sendy's API. Subscribe, unsubscribe, access subscriber status, lists, create and list campaigns. It was built to interact with version 1.1.6

Sendyr →

A Ruby interface for Sendy.

Cindy →

A lightweight and flexible Ruby SDK for Sendy.

Pysendy →

Pysendy is a Python wrapper for Sendy's API.

Sendy Perl SDK →

Perl SDK to Sendy.

Join our newsletter