Sendy

Subscribers

• Subscribe
• Unsubscribe
• Subscription status
• Active subscriber count

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: Sendy 1.0.8 or later supports custom fields. To add values to your desired custom field, use the personalization tag of the custom field as the parameter. Say if 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: Already subscribed.

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.

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

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