Reloop PHP SDK

The official PHP SDK for Reloop, providing a convenient, PSR-4 compliant wrapper around the Reloop REST API.

Requirements

• PHP 8.1 or higher
• Composer

Installation

Install the package via Composer:

composer require reloop/reloop-email

Getting Started

Install the SDK with Composer, then initialize the client with your API key:

composer require reloop/reloop-email

$reloop = Reloop::client('rl_your_api_key_here');

API Key Management

$reloop = Reloop::client('rl_your_api_key_here');

$reloop->apiKeys->list(
  options: [
    'page' => 1,
    'limit' => 10,
  ],
);

$reloop->apiKeys->create(
  parameters: [
    'name' => 'Production Key',
    'enabled' => true,
    'rate_limit_enabled' => true,
  ],
);

$reloop->apiKeys->get('api_key_id_here');
$reloop->apiKeys->update('api_key_id_here', parameters: ['name' => 'New Name']);
$reloop->apiKeys->delete('api_key_id_here');
$reloop->apiKeys->rotate('api_key_id_here');
$reloop->apiKeys->disable('api_key_id_here');
$reloop->apiKeys->enable('api_key_id_here');

Contacts

Manage contacts, custom properties, groups, and channels via $reloop->contacts. Methods accept snake_case parameters and options arrays and return typed resource objects with snake_case properties.

Create a contact

$reloop = Reloop::client('re_123456789');

$reloop->contacts->create(
  parameters: [
    'email' => 'steve.wozniak@gmail.com',
    'first_name' => 'Steve',
    'last_name' => 'Wozniak',
    'unsubscribed' => false,
  ],
);

You can also pass Reloop-specific fields directly:

$contact = $reloop->contacts->create(
    parameters: [
        'email' => 'john.doe@example.com',
        'first_name' => 'John',
        'last_name' => 'Doe',
        'status' => 'subscribed',
        'channels' => [
            [
                'channel_id' => 'chn_123456789',
                'subscription' => 'opt_in',
            ],
        ],
    ],
);

List, get, update, and delete contacts

$list = $reloop->contacts->list(options: [
    'page' => 1,
    'limit' => 10,
]);

foreach ($list->contacts as $contact) {
    echo $contact->email;
}

$contact = $reloop->contacts->get('cont_123456789');
echo $contact->first_name;

$updated = $reloop->contacts->update(
    'cont_123456789',
    parameters: [
        'first_name' => 'Jane',
        'unsubscribed' => false,
    ],
);

$result = $reloop->contacts->delete('cont_123456789');
echo $result->success;

Custom properties

$property = $reloop->contacts->createProperty(
    parameters: [
        'name' => 'company_name',
        'type' => 'string',
        'fallback_value' => 'Unknown',
    ],
);

$properties = $reloop->contacts->listProperties(options: [
    'page' => 1,
    'limit' => 10,
]);

$updatedProperty = $reloop->contacts->updateProperty(
    'prop_123456789',
    parameters: [
        'fallback_value' => 'N/A',
    ],
);

$reloop->contacts->deleteProperty('prop_123456789');

Groups

$group = $reloop->contacts->createGroup(
    parameters: ['name' => 'Beta Testers'],
);

$groups = $reloop->contacts->listGroups(options: [
    'page' => 1,
    'limit' => 10,
]);

$oneGroup = $reloop->contacts->getGroup('grp_123456789');
$updatedGroup = $reloop->contacts->updateGroup(
    'grp_123456789',
    parameters: ['name' => 'Early Access'],
);
$reloop->contacts->deleteGroup('grp_123456789');

$reloop->contacts->groups->addContact(
    'grp_123456789',
    parameters: ['contact_id' => 'cont_123456789'],
);
$reloop->contacts->groups->removeContact(
    'grp_123456789',
    parameters: ['email' => 'john.doe@example.com'],
);
$groupContacts = $reloop->contacts->groups->listContacts(
    'grp_123456789',
    options: ['page' => 1, 'limit' => 10],
);

Channels

$channel = $reloop->contacts->channels->create(
    parameters: [
        'name' => 'Product Updates',
        'default_subscription' => 'opt_in',
        'visibility' => 'public',
    ],
);

$channels = $reloop->contacts->channels->list(options: [
    'page' => 1,
    'limit' => 10,
]);

$oneChannel = $reloop->contacts->channels->get('chn_123456789');
$updatedChannel = $reloop->contacts->channels->update(
    'chn_123456789',
    parameters: ['name' => 'Marketing News'],
);
$reloop->contacts->channels->delete('chn_123456789');

$reloop->contacts->channels->addContact(
    'chn_123456789',
    parameters: [
        'contact_id' => 'cont_123456789',
        'subscription' => 'opt_in',
    ],
);
$reloop->contacts->channels->updateSubscription(
    'chn_123456789',
    parameters: [
        'contact_id' => 'cont_123456789',
        'subscription' => 'opt_in',
    ],
);

License

ISC