Laravel Instantly

https://github.com/jeffersongoncalves/laravel-instantly
Admin
Laravel Instantly is a PHP and Laravel client for the Instantly.ai REST API, providing a fluent...
Tokens:1,711
Snippets:34
Trust Score:9.8
License:MIT
Update:1 month ago
Show doc for...
Tokens:
Raw
### Install via Composer

Source: https://github.com/jeffersongoncalves/laravel-instantly/blob/main/README.md

Install the package via Composer.

```bash
composer require jeffersongoncalves/laravel-instantly
```

--------------------------------

### Campaigns

Source: https://github.com/jeffersongoncalves/laravel-instantly/blob/main/README.md

Campaign operations: list, get, status, launch, and pause.

```php
Instantly::campaigns()->list(limit: 10, skip: 0);
Instantly::campaigns()->get('campaign-id');
Instantly::campaigns()->status('campaign-id');
Instantly::campaigns()->launch('campaign-id');
Instantly::campaigns()->pause('campaign-id');
```

--------------------------------

### Import Facade and Exception

Source: https://github.com/jeffersongoncalves/laravel-instantly/blob/main/README.md

Import the Instantly facade and exception class.

```php
use JeffersonGoncalves\Instantly\Facades\Instantly;
use JeffersonGoncalves\Instantly\Exceptions\InstantlyException;
```

--------------------------------

### Config Options

Source: https://github.com/jeffersongoncalves/laravel-instantly/blob/main/README.md

Configuration options for the package. The base_url defaults to the Instantly API v1 endpoint.

```php
// config/instantly.php
return [
    'api_key' => env('INSTANTLY_API_KEY'),
    'base_url' => env('INSTANTLY_BASE_URL', 'https://api.instantly.ai/api/v1'),
];
```

--------------------------------

### Run Static Analysis

Source: https://github.com/jeffersongoncalves/laravel-instantly/blob/main/README.md

Run static analysis.

```bash
composer analyse
```

--------------------------------

### Run Tests

Source: https://github.com/jeffersongoncalves/laravel-instantly/blob/main/README.md

Run the test suite.

```bash
composer test
```

--------------------------------

### Set API Key in .env

Source: https://github.com/jeffersongoncalves/laravel-instantly/blob/main/README.md

Add your Instantly API key to the .env file. Find it under Settings → Integrations.

```env
INSTANTLY_API_KEY=your-api-key
```

--------------------------------

### Publish Config File

Source: https://github.com/jeffersongoncalves/laravel-instantly/blob/main/README.md

Optionally publish the config file.

```bash
php artisan vendor:publish --tag="instantly-config"
```

--------------------------------

### Run Code Formatting

Source: https://github.com/jeffersongoncalves/laravel-instantly/blob/main/README.md

Run code formatting.

```bash
composer format
```

--------------------------------

### Accounts

Source: https://github.com/jeffersongoncalves/laravel-instantly/blob/main/README.md

Account operations: list, status, and warmup status.

```php
Instantly::accounts()->list(limit: 10);
Instantly::accounts()->status('inbox@acme.com');
Instantly::accounts()->warmupStatus('inbox@acme.com');
```

--------------------------------

### Leads

Source: https://github.com/jeffersongoncalves/laravel-instantly/blob/main/README.md

Lead operations: list, add, delete, and status.

```php
Instantly::leads()->list('campaign-id', limit: 10);
Instantly::leads()->add('campaign-id', [
    'email' => 'lead@acme.com',
    'first_name' => 'Jane',
    'last_name' => 'Doe',
    'company_name' => 'Acme',
]);
Instantly::leads()->delete('campaign-id', 'lead@acme.com');
Instantly::leads()->status('campaign-id', 'lead@acme.com');
```

--------------------------------

### Blocklist

Source: https://github.com/jeffersongoncalves/laravel-instantly/blob/main/README.md

Blocklist operations: list and add.

```php
Instantly::blocklist()->list();
Instantly::blocklist()->add(['spam.com', 'bad@spam.com']);
```

--------------------------------

### Handling Errors

Source: https://github.com/jeffersongoncalves/laravel-instantly/blob/main/README.md

Handles errors: InstantlyException for API errors, InvalidArgumentException for missing required parameters.

```php
try {
    $result = Instantly::campaigns()->launch('campaign-id');
} catch (InstantlyException $e) {
    // $e->getMessage() — the API's error message, or the raw response body
    // $e->errorBody()   — the full decoded JSON error response
} catch (InvalidArgumentException $e) {
    // a required parameter was empty
}
```

--------------------------------

### Analytics

Source: https://github.com/jeffersongoncalves/laravel-instantly/blob/main/README.md

Analytics operations: campaign summary, campaign steps, and account count.

```php
Instantly::analytics()->campaignSummary('campaign-id', start_date: '2026-01-01', end_date: '2026-01-31');
Instantly::analytics()->campaignSteps('campaign-id');
Instantly::analytics()->accountCount('2026-01-01', '2026-01-31');
```
Tokens:
Raw