PHPackages                             avadaio/avadaio-php-client - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. avadaio/avadaio-php-client

ActiveLibrary

avadaio/avadaio-php-client
==========================

AVADA Email Marketing API bindings for PHP

00PHP

Since Sep 17Pushed 4y ago1 watchersCompare

[ Source](https://github.com/avadaio/php-lib)[ Packagist](https://packagist.org/packages/avadaio/avadaio-php-client)[ RSS](/packages/avadaio-avadaio-php-client/feed)WikiDiscussions master Synced 5d ago

READMEChangelogDependenciesVersions (1)Used By (0)

AVADA Email Marketing API - PHP
===============================

[](#avada-email-marketing-api---php)

AVADA Email Marketing API bindings for PHP to make it easier for developer to connect with AVADA Marketing Automation platform.

Table of Contents
-----------------

[](#table-of-contents)

- [Installation](#installation)
- [API](#api)
- [Examples](#examples)
- [Support](#support)

Installation
------------

[](#installation)

```
composer require avadaio/avadaio-php-client
```

API
---

[](#api)

Our API documentation is located at: [AVADA API Documentation](https://documenter.getpostman.com/view/10585474/TVmPAHH9#654363ae-7cd2-4236-a5e1-818ab87ecde0). You can see our API for more reference.

### Init instance

[](#init-instance)

AvadaIoSdk uses curl extension for handling http calls. So you need to have the curl extension installed and enabled with PHP.

```
$avadaio = new AvadaIo\AvadaIoSdk([
    'appId' => "[YOUR_APP_ID]",
    "appKey" => "[YOUR_APP_KEY]"
]);
```

This module exports a constructor function which takes an associative array.

### `AvadaIoSdk(options)`

[](#avadaiosdkoptions)

Creates a new `AVADA` instance.

#### Arguments

[](#arguments)

- `options` - Required - An associative array with two indexes

#### Options

[](#options)

- `appId` - Required
- `appKey` - Required

You can obtain your `appId` and `appKey` after creating an account with AVADA and go to the Manage Keys page

#### Return value

[](#return-value)

An `AvadaIoSdk` instance.

#### Exceptions

[](#exceptions)

Throws an `SdkException` exception if the required options are missing.

Resources
---------

[](#resources)

Every resource is accessed via your `$avadaio` instance:

```
$avadaio = new AvadaIo\AvadaIoSdk([
    'appId' => "[YOUR_APP_ID]",
    "appKey" => "[YOUR_APP_KEY]"
]);

// $avadaio->->
```

Each method returns `ApiResponse` object with 3 properties:

- `success` - boolean
- `data` - any - optional
- `message` - string

```
$result = $avadaio->Contact->create([
    "description" => "",
    "email" => "john@doe.io",
    "firstName" => "John",
    "isSubscriber" => true,
    "lastName" => "Doe",
    "phoneNumber" => "+123465789",
    "phoneNumberCountry" => "US",
    "source" => "magento",
    "orderCount" => 0,
    "totalSpent" => 0,
    "country" => "US",
    "city" => "",
    "address" => "",
    "tags" => "Email Marketing"
]);
```

The JSON return from the API is like this:

```
{"success": true, "message": "Hook create/update customers complete"}
```

This behavior is the same for all resources.

Examples
--------

[](#examples)

### Test connection

[](#test-connection)

```
 $result = $avadaio->Connection->test();
if ($result->success) {
  echo 'Connection established';
}
```

More examples can be found in the `tests` folder in the project source code.

Available resources and methods
-------------------------------

[](#available-resources-and-methods)

- Connection
    - `test()` Test the connection using your `appKey` and `appId`
- Form
    - `list()` Get a list of inline forms to integrate AVADA Forms into your page builder
- Contact
    - `create(data)` Create a new contact in your AVADA admin
    - `update(data)` Update an existing contact in your AVADA admin
    - `bulk(data)` Create new contacts in your AVADA admin in bulk
- Subscriber
    - `add(data)` Add a new contact to your contact list as a subscriber. Trigger the New Subscriber automation event.
- Review
    - `submit(data)` Trigger the submit of a new review on your store. Trigger On new review automation event.
- Checkout
    - `create(data)` Trigger a new checkout event to AVADA, which will be used for the Abandoned Cart Automation.
    - `update(data)` Trigger an update to a checkout event to AVADA. For example, update checkout email so that the cart will be qualified for Abandoned Cart Email.
    - `remove(id)` Remove a checkout.
- Order
    - `create(data)` Trigger a new order event to AVADA. Trigger New Order automation event.
    - `update(data)` Update an existing order.
    - `complete(data)` Complete an order. Trigger Cross-sell, Up-sell automation events.
    - `bulk(data)` Sync your orders to AVADA using bulk order inserts.
    - `refund(data)` Trigger a refund event to AVADA
    - `invoice(data)` Trigger a fulfillment event to AVADA
    - `ship(data)` Trigger a shipping event to AVADA

Support
-------

[](#support)

If you need any support, you can reach to us within our customer chat support inside your app

###  Health Score

15

—

LowBetter than 3% of packages

Maintenance20

Infrequent updates — may be unmaintained

Popularity0

Limited adoption so far

Community9

Small or concentrated contributor base

Maturity28

Early-stage or recently created project

 Bus Factor1

Top contributor holds 61.1% of commits — single point of failure

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

### Community

Maintainers

![](https://www.gravatar.com/avatar/0fa2e89b2066e17dfd55e0f297b701b62a3a5a544e37feb8aecee0e81345509f?d=identicon)[thomas\_avadaio](/maintainers/thomas_avadaio)

---

Top Contributors

[![thomasavada](https://avatars.githubusercontent.com/u/103809857?v=4)](https://github.com/thomasavada "thomasavada (11 commits)")[![anhnt-mageplaza](https://avatars.githubusercontent.com/u/30231551?v=4)](https://github.com/anhnt-mageplaza "anhnt-mageplaza (7 commits)")

### Embed Badge

![Health badge](/badges/avadaio-avadaio-php-client/health.svg)

```
[![Health](https://phpackages.com/badges/avadaio-avadaio-php-client/health.svg)](https://phpackages.com/packages/avadaio-avadaio-php-client)
```

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)