Ahmad Awais



Open Sourcing My Sendy PHP API Wrapper

Ahmad AwaisAhmad Awais

I recently started using Sendy.co (aff) to send emails. I was having trouble finding a good API wrapper for it. Spent more than five hours searching for one and ended up building one myself. I hope it helps.

🚀 GITHUB: ★ 54 ⑂ 15 →#

🚀 Sendy PHP API Wrapper: Complete API interfacing.



With this Sendy PHP API Wrapper you can do the following:

Subscribe Set List Create
Unsubscribe Get List Draft
Delete subscriber Active subscriber count Send
Subscription status List Segments handling Assign to brands

Getting Started#

Getting started is easy. Here’s how you do it. You can check the example.php file as well. Obviously, you’ll have to download the wrapper to your current setup. Several ways to do that.


Git clone this repo and include ./src/Sendy.php in your project.


Composer Install is the preferred method.

composer require ahmadawais/sendy-php-api

Step 0. Require the wrapper#

require_once( 'Sendy.php' );

Step 1. Configure it#

// 2. Configuration.
$config = [
    'sendyUrl' => 'https://send_installation_url.com', // Your Sendy installation URL (without trailing slash).
    'apiKey'   => 'XXXXXXXXXXXXXXXX', // Your API key. Available in Sendy Settings.
    'listId'   => 'XXXXXXXXXXXXXXXX',

Step 2. Init#

$sendy = new \SENDY\API( $config );


  1. Method: subscribe().
  2. Method: unsubscribe().
  3. Method: subStatus().
  4. Method: delete().
  5. Method: subCount().
  6. Method: campaign().

Method #1: Subscribe#

// Method #1: Subscribe.
$responseArray = $sendy->subscribe(
        'email'     => '[email protected]', // This is the only field required by sendy.
        'name'      => 'Name', // User name (optional).
        'custom'    => 'Field Value', // You can custom fields as well (optional).
        'country'   => 'US', // User 2 letter country code (optional).
        'ipaddress' => 'XX.XX.XX.XXX', // User IP address (optional).
        'referrer'  => 'https://AhmadAwais.com/', // URL where the user signed up from (optional).
        'gdpr'      => true, // GDPR compliant? Set this to "true" (optional).

Method #2: Unsubscribe#

$responseArray = $sendy->unsubscribe( '[email protected]' );

Method #3: Subscriber Status#

$responseArray = $sendy->subStatus( '[email protected]' );

Method #4: Delete Subscriber#

$responseArray = $sendy->delete( '[email protected]' );

Method #5: Subscriber Count of a list#

$responseArray = $sendy->subCount();

Method #6: Campaign — Draft And/Or Send as well#

// Method #6: Campaign — Draft And/Or Send as well.
$responseArray = $sendy->campaign(
        'from_name'            => 'Your Name',
        'from_email'           => '[email protected]',
        'reply_to'             => '[email protected]',
        'title'                => 'Title', // the title of your campaign.
        'subject'              => 'Your Subject',
        'plain_text'           => 'An Amazing campaign', // Optional.
        'html_text'            => '<h1>Amazing campaign</h1>',
        'brand_id'             => 1, // Required only if you are creating a 'Draft' campaign. That is `send_campaign` set to 0.
        'send_campaign'        => 0, // SET: Draft = 0 and Send = 1 for the campaign.
        // Required only if you set send_campaign to 1 and no `segment_ids` are passed in.. List IDs should be single or comma-separated.
        'list_ids'             => 'XXXXXXXX, XXXXXXXX',
        // 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'          => '1',
        // Lists to exclude. List IDs should be single or comma-separated. (optional).
        'exclude_list_ids'     => '',
        // Segments to exclude. Segment IDs should be single or comma-separated. (optional).
        'exclude_segments_ids' => '',
        'query_string'         => 'XXXXXXXX', // Eg. Google Analytics tags.

Method #7: Set List ID#

// Method #7: Change the `XXXXXXX` you are referring to at any point.
$sendy->setListId( 'XXXXXXX' );

Method #8: Get List ID#

// Method #7: Get the `XXXXXXX` you are referring to at any point.


The response of this PHP wrapper is custom-built. At the moment, it always returns a PHP Array. This array has the status of your action and an appropriate message in the response.

    // E.g. SUCCESS response.
        'status'  => true,
        'message' => 'Already Subscribed'

    // E.g. FAIL response.
        'status'  => false,
        'message' => 'Some fields are missing.'



❯ Read the changelog here →


I use Emoji-log, you should try it and simplify your git commits.


License & Conduct#



GitHub @AhmadAwais (follow) To stay up to date on free & open-source software

Twitter @MrAhmadAwais (follow) To get #OneDevMinute daily hot tips & trolls

YouTube AhmadAwais (subscribe) To tech talks & #OneDevMinute videos

Blog: AhmadAwais.com (read) In-depth & long form technical articles

LinkedIn @MrAhmadAwais (connect) On the LinkedIn profile y’all


Me (Ahmad Awais) and my incredible wife (Maedah Batool) are two engineers who fell in love with open source and then with each other. You can read more about me here. If you or your company use any of my projects or like what I’m doing then consider backing me. I’m in this for the long run. An open-source developer advocate.

Or you can back me by checking out my super fun video course. As developers, we spend over 200 Hrs/month with our code editors — it’s only fair to learn your next editor deeply. This course will save you 15-20 hours every month. Become a VSCode Power User


Ahmad on Twitter

This also happens to be my first composer package, so yay! 🎉

Feedback is more than welcomed at GitHub.

👨‍🏫 Edutainer at VSCode.pro 🎩 An award-winning open-source engineer and developer advocate 🦊 Google Developers Expert for web 🌳 Node.js foundation Community Committee member ✌️ Author of various open-source dev-tools and software libraries used by millions of developers worldwide ⓦ WordPress Core Developer 📣 TEDx Speaker 🙌 Leading developers and publishing technical content for over a decade 😂 Self-confessed tech comedian cracking silly jokes in the JavaScript web and cloud communities 💜 Loves his wife (Maedah) ❯ Learn more about Awais ↣

Say 👋 on Twitter @MrAhmadAwais | Subscribe to the Developers Takeaway!


TheDevTakeaway: Developers' Newsletter!

Takeaway my professional opinion about Open Source, JavaScript/Cloud, Full Stack Development, building a business, growing a family, and everything in between! Delivered to your inbox once a month. 🤣 I'm even funny some times. 👻 I hate spam! Pinky Promise!