Brevo PHP

https://github.com/getbrevo/brevo-php
Admin
Brevo PHP is an official SDK for the Brevo API v3 that enables developers to access all Brevo...
Tokens:242,967
Snippets:1,856
Trust Score:7.2
License:MIT
Update:1 month ago
Show doc for...
Tokens:
Raw
### Install dependencies with composer install

Source: https://github.com/getbrevo/brevo-php/blob/main/CONTRIBUTING.md

Installs the project dependencies using Composer. Required before running tests or other development commands.

```bash
composer install
```

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

### Basic Usage Example

Source: https://github.com/getbrevo/brevo-php/blob/main/_autodocs/api-reference/brevo.md

Example showing how to create a Brevo client and call the `getAccount` method on the account resource.

```APIDOC
## Basic Usage

### Description
Demonstrates how to instantiate the Brevo client and call a resource method.

### Method
N/A (SDK usage)

### Endpoint
`$client->account->getAccount()`

### Parameters
None.

### Request Example
```php
use Brevo\Brevo;

$client = new Brevo(
    apiKey: 'xkeysib-0000000000000000000000000000000000000000000000000000000000000000',
);
$result = $client->account->getAccount();
```

### Response
Returns the result of the `getAccount` method on the `account` resource client.
```

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

### Custom Client Configuration Example

Source: https://github.com/getbrevo/brevo-php/blob/main/_autodocs/api-reference/brevo.md

Example demonstrating custom client configuration and error handling when calling a transactional email method.

```APIDOC
## Custom PSR-18 Client + Timeout

### Description
Shows how to configure the Brevo client with a custom PSR-18 HTTP client, timeout, retries, base URL, and additional headers.

### Method
N/A (SDK usage)

### Endpoint
`new Brevo(string $apiKey, array $options)`

### Parameters
- **apiKey** (string) - Required - API key.
- **options** (array) - Optional - Configuration options:
  - `client` (ClientInterface) - Any PSR-18 client, else php-http/discovery.
  - `timeout` (float) - Per-request timeout in seconds (Guzzle/Symfony only).
  - `maxRetries` (int) - Retry attempts before giving up (default 2).
  - `baseUrl` (string) - Base URL for the API.
  - `headers` (array<string, string>) - Additional headers.

### Request Example
```php
use Brevo\Brevo;
use Brevo\Exceptions\BrevoApiException;

$customClient = new \GuzzleHttp\Client(['timeout' => 5.0]);

$client = new Brevo(
    apiKey: 'xkeysib-xxx',
    options: [
        'client' => $customClient,
        'timeout' => 30.0,
        'maxRetries' => 3,
        'baseUrl' => 'https://api.brevo.com/v3',
        'headers' => ['X-Tenant' => 'acme'],
    ],
);

try {
    $client->transactionalEmails->sendTransacEmail(...);
} catch (BrevoApiException $e) {
    echo $e->getMessage() . ' [' . $e->getCode() . ']: ' . $e->getBody();
}
```

### Response
No direct response; the example shows error handling with `BrevoApiException`.
```

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

### Install Brevo PHP SDK via Composer

Source: https://github.com/getbrevo/brevo-php/blob/main/README.md

Use this command to install the Brevo PHP SDK. Requires PHP ^8.1.

```sh
composer require getbrevo/brevo-php
```

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

### getAccount usage example

Source: https://github.com/getbrevo/brevo-php/blob/main/_autodocs/api-reference/account.md

Example usage of getAccount to retrieve and display the account's company name and plan type.

```php
$account = $client->account->getAccount();
echo $account?->companyName . ' / plan: ' . $account?->plan[0]->type;
```

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

### Send Test Template Example

Source: https://github.com/getbrevo/brevo-php/blob/main/_autodocs/api-reference/transactional-emails.md

Example of sending a test email to a specified address using the sendTestTemplate method.

```php
use Brevo\TransactionalEmails\Requests\SendTestTemplateRequest;
use Brevo\Types\SendTestEmail;

$client->transactionalEmails->sendTestTemplate(
    7,
    new SendTestTemplateRequest(['body' => new SendTestEmail(['emailTo' => ['qa@example.com']])]),
);
```

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

### Manual request using RawClient

Source: https://github.com/getbrevo/brevo-php/blob/main/_autodocs/api-reference/core-client.md

Example of directly using RawClient with a JsonApiRequest to send a GET request to the account endpoint. Requires an API key header.

```php
$rawClient = new RawClient([
    'headers' => ['api-key' => 'xkeysib-xxx'],
]);
$response = $rawClient->sendRequest(
    new JsonApiRequest(
        baseUrl: 'https://api.brevo.com/v3',
        path: 'account',
        method: HttpMethod::GET,
    ),
);
```

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

### createContact usage example

Source: https://github.com/getbrevo/brevo-php/blob/main/_autodocs/api-reference/contacts.md

Example of calling createContact with a CreateContactRequest.

```php
use Brevo\Contacts\Requests\CreateContactRequest;

$client->contacts->createContact(
    new CreateContactRequest([
        'email' => 'jane.doe@example.com',
        'attributes' => ['FNAME' => 'Jane', 'COUNTRIES' => ['France']],
        'listIds' => [12, 15],
        'updateEnabled' => true,
    ]),
);
```

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

### getAccountActivity usage example

Source: https://github.com/getbrevo/brevo-php/blob/main/_autodocs/api-reference/account.md

Example usage of getAccountActivity with a request DTO specifying startDate, endDate, and limit. Iterates over the returned logs to display user email and action.

```php
use Brevo\Account\Requests\GetAccountActivityRequest;

$activities = $client->account->getAccountActivity(
    new GetAccountActivityRequest([
        'startDate' => '2025-01-01',
        'endDate'   => '2025-01-31',
        'limit'     => 100,
    ]),
);
foreach ($activities?->logs ?? [] as $log) {
    echo $log->userEmail . ' -> ' . $log->action . PHP_EOL;
}
```

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

### Create SMTP Template Example

Source: https://github.com/getbrevo/brevo-php/blob/main/_autodocs/api-reference/transactional-emails.md

Example of creating an SMTP template with required sender, subject, and templateName, plus optional htmlContent and isActive.

```php
use Brevo\TransactionalEmails\Requests\CreateSmtpTemplateRequest;
use Brevo\TransactionalEmails\Types\CreateSmtpTemplateRequestSender;

$client->transactionalEmails->createSmtpTemplate(
    new CreateSmtpTemplateRequest([
        'templateName' => 'Welcome',
        'subject' => 'Welcome!',
        'htmlContent' => '<p>Hi {{FIRSTNAME}}</p>',
        'sender' => new CreateSmtpTemplateRequestSender(['email' => 'hello@example.com']),
        'isActive' => true,
    ]),
);
```

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

### GET products

Source: https://github.com/getbrevo/brevo-php/blob/main/_autodocs/endpoints.md

Retrieves the list of products.

```APIDOC
## GET products

### Description
Retrieves the list of products.

### Method
GET

### Endpoint
products

### Response
#### Success Response (200)
- **GetProductsResponse** - The response containing the list of products.

#### Response Example
```json
{
  "products": []
}
```
```

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

### getContacts usage example

Source: https://github.com/getbrevo/brevo-php/blob/main/_autodocs/api-reference/contacts.md

Example of calling getContacts with a GetContactsRequest.

```php
use Brevo\Contacts\Requests\GetContactsRequest;

$page = $client->contacts->getContacts(
    new GetContactsRequest(['limit' => 50, 'offset' => 0, 'sort' => 'desc']),
);
```

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

### Get parameter subscription info with getParameterSubscriptionInfo

Source: https://github.com/getbrevo/brevo-php/blob/main/reference.md

Gets information of balances, tiers, rewards, and subscription members for a subscription. The $pid parameter identifies the loyalty program.

```php
$client->program->getParameterSubscriptionInfo(
    'pid',
    new GetParameterSubscriptionInfoRequest([]),
);
```

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

### GET whatsappCampaigns/config

Source: https://github.com/getbrevo/brevo-php/blob/main/_autodocs/endpoints.md

Retrieves the WhatsApp configuration.

```APIDOC
## GET whatsappCampaigns/config

### Description
Retrieves the WhatsApp configuration.

### Method
GET

### Endpoint
whatsappCampaigns/config

### Response
#### Success Response (200)
- **GetWhatsAppConfigResponse** - The response containing the WhatsApp configuration.

#### Response Example
```json
{
  "whatsappBusinessAccountId": "string"
}
```
```

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

### GET /loyalty/config/programs

Source: https://github.com/getbrevo/brevo-php/blob/main/_autodocs/endpoints-part2.md

Retrieves the list of loyalty programs.

```APIDOC
## GET /loyalty/config/programs

### Description
Retrieves the list of loyalty programs.

### Method
GET

### Endpoint
`/loyalty/config/programs`

### Response
#### Success Response (200)
- **GetLpListResponse** - The list of loyalty programs.

```

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

### GET /crm/pipeline/details/all

Source: https://github.com/getbrevo/brevo-php/blob/main/_autodocs/endpoints-part2.md

Retrieves all pipelines.

```APIDOC
## GET /crm/pipeline/details/all

### Description
Retrieves all pipelines.

### Method
GET

### Endpoint
/crm/pipeline/details/all

### Response
#### Success Response (200)
- **array** - The list of pipelines.

#### Response Example
```json
[]
```
```

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

### GET wallet/passes/{$passId}/installUrl/{$contactId}

Source: https://github.com/getbrevo/brevo-php/blob/main/_autodocs/endpoints.md

Retrieves the wallet pass install URL for a specific pass and contact.

```APIDOC
## GET wallet/passes/{$passId}/installUrl/{$contactId}

### Description
Retrieves the wallet pass install URL for a specific pass and contact.

### Method
GET

### Endpoint
`wallet/passes/{$passId}/installUrl/{$contactId}`

### Parameters
#### Path Parameters
- **$passId** (string) - Required - The ID of the wallet pass.
- **$contactId** (string) - Required - The ID of the contact.

### Response
#### Success Response (200)
Returns a `WalletPassInstallUrl` object.

```

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

### Basic usage of Brevo client

Source: https://github.com/getbrevo/brevo-php/blob/main/_autodocs/api-reference/brevo.md

Basic usage example: instantiate the Brevo client with an API key and call a resource method.

```php
use Brevo\Brevo;

$client = new Brevo(
    apiKey: 'xkeysib-0000000000000000000000000000000000000000000000000000000000000000',
);
$result = $client->account->getAccount();
```

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

### Create a domain with createDomain()

Source: https://github.com/getbrevo/brevo-php/blob/main/reference.md

Creates a new domain in Brevo. Use to add sending domains, set up authentication for deliverability, configure DNS records, and establish sender identities. Returns created domain ID, required DNS records, provider detection results, and setup instructions. The $name parameter is a string representing the domain name to add.

```php
$client->domains->createDomain(
    new CreateDomainRequest([
        'name' => 'mycompany.com',
    ]),
);
```

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

### Get all CRM tasks with GetAllTasks

Source: https://github.com/getbrevo/brevo-php/blob/main/reference.md

Retrieves a paginated list of CRM tasks with optional filters. The example passes a GetCrmTasksRequest with 'sortBy' set to 'name'. Default limit is 50 tasks per page and default sort is descending by creation date.

```php
$client->tasks->getAllTasks(
    new GetCrmTasksRequest([
        'sortBy' => 'name',
    ]),
);
```

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

### Get Account Details with getAccount()

Source: https://github.com/getbrevo/brevo-php/blob/main/reference.md

Retrieves details of your Brevo account, including account information, plan details, relay information, Marketing Automation status, and organization/user identifiers. Use this to check plan limitations, feature availability, and configuration for billing and transactional email setup.

```php
$client->account->getAccount();
```

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

### Begin a transaction with $client->balance->beginTransaction

Source: https://github.com/getbrevo/brevo-php/blob/main/reference.md

Creates a new transaction. Requires a loyalty program ID and a BeginTransactionRequest with amount and balanceDefinitionId. The amount sign determines credit/debit unless transactionType is provided.

```php
$client->balance->beginTransaction(
    'pid',
    new BeginTransactionRequest([
        'amount' => 1.1,
        'balanceDefinitionId' => 'balanceDefinitionId',
    ]),
);
```

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

### importContacts usage example

Source: https://github.com/getbrevo/brevo-php/blob/main/_autodocs/api-reference/contacts.md

Example of calling importContacts with an ImportContactsRequest.

```php
use Brevo\Contacts\Requests\ImportContactsRequest;

$client->contacts->importContacts(
    new ImportContactsRequest([
        'fileUrl' => 'https://example.com/contacts.csv',
        'listIds' => [12],
        'updateExistingContacts' => true,
        'notifyUrl' => 'https://example.com/import-webhook',
    ]),
);
```

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

### $client->program->createNewLp($request) -> ?LoyaltyProgram

Source: https://github.com/getbrevo/brevo-php/blob/main/reference.md

Creates a new loyalty program with the provided details. Requires a name for the program.

```APIDOC
## $client->program->createNewLp($request) -> ?LoyaltyProgram

### Description
Creates loyalty program

### Method
POST

### Endpoint
$client->program->createNewLp

### Parameters
#### Request Body
- **$description** (?string) - Optional - Optional description of the loyalty program (max 256 chars).
- **$documentId** (?string) - Optional - Optional unique document ID.
- **$meta** (?array) - Optional - Optional metadata related to the loyalty program.
- **$name** (string) - Required - Required name of the loyalty program (max 128 chars).

### Request Example
```php
$client->program->createNewLp(
    new CreateNewLpRequest([
        'name' => 'name',
    ]),
);
```

### Response
#### Success Response (200)
- **LoyaltyProgram** - The created loyalty program object

#### Response Example
```php
?LoyaltyProgram
```
```

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

### createDoiContact usage example

Source: https://github.com/getbrevo/brevo-php/blob/main/_autodocs/api-reference/contacts.md

Example of calling createDoiContact with a CreateDoiContactRequest.

```php
use Brevo\Contacts\Requests\CreateDoiContactRequest;

$client->contacts->createDoiContact(
    new CreateDoiContactRequest([
        'email' => 'new@example.com',
        'templateId' => 2,
        'redirectionUrl' => 'https://example.com/confirmed',
        'includeListIds' => [12],
    ]),
);
```

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

### POST products

Source: https://github.com/getbrevo/brevo-php/blob/main/_autodocs/endpoints.md

Creates or updates a product.

```APIDOC
## POST products

### Description
Creates or updates a product.

### Method
POST

### Endpoint
products

### Request Body
- **id** (string) - Required - The ID of the product.
- **name** (string) - Required - The name of the product.
- **price** (number) - Required - The price of the product.

### Request Example
```json
{
  "id": "prod123",
  "name": "Laptop",
  "price": 999.99
}
```

### Response
#### Success Response (200)
- **CreateUpdateProductResponse** - The response containing the product ID.

#### Response Example
```json
{
  "id": "prod123"
}
```
```

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

### GET /loyalty/config/programs/{$pid}

Source: https://github.com/getbrevo/brevo-php/blob/main/_autodocs/endpoints-part2.md

Retrieves information about a specific loyalty program.

```APIDOC
## GET /loyalty/config/programs/{$pid}

### Description
Retrieves information about a specific loyalty program.

### Method
GET

### Endpoint
`/loyalty/config/programs/{$pid}`

### Parameters
#### Path Parameters
- **pid** (string) - Required - The loyalty program ID.

### Response
#### Success Response (200)
- **LoyaltyProgram** - The loyalty program details.

```

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

### Get blocked domains with getBlockedDomains

Source: https://github.com/getbrevo/brevo-php/blob/main/reference.md

Gets the list of blocked domains.

```php
$client->transactionalEmails->getBlockedDomains();
```

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

### Create reward with $client->reward->createReward

Source: https://github.com/getbrevo/brevo-php/blob/main/reference.md

Creates a new reward in the loyalty program. Requires the loyalty program ID and a reward name; optional fields include public description, image, and name.

```php
$client->reward->createReward(
    'pid',
    new CreateRewardRequest([
        'name' => 'name',
    ]),
);
```

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

### Example: getSmsEvents usage

Source: https://github.com/getbrevo/brevo-php/blob/main/_autodocs/api-reference/transactional-sms.md

Example of retrieving SMS events using GetSmsEventsRequest with phoneNumber and limit.

```php
use Brevo\TransactionalSms\Requests\GetSmsEventsRequest;

$events = $client->transactionalSms->getSmsEvents(
    new GetSmsEventsRequest(['phoneNumber' => '+33612345678', 'limit' => 100]),
);
```

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

### POST /loyalty/config/programs

Source: https://github.com/getbrevo/brevo-php/blob/main/_autodocs/endpoints-part2.md

Creates a new loyalty program.

```APIDOC
## POST /loyalty/config/programs

### Description
Creates a new loyalty program.

### Method
POST

### Endpoint
`/loyalty/config/programs`

### Response
#### Success Response (200)
- **LoyaltyProgram** - The created loyalty program.

```

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

### Create voucher with $client->reward->createVoucher

Source: https://github.com/getbrevo/brevo-php/blob/main/reference.md

Creates a voucher and attributes it to a specific membership. Requires the loyalty program ID and reward ID; optional parameters include code, contactId, expirationDate, loyaltySubscriptionId, meta, value, and validFrom.

```php
$client->reward->createVoucher(
    'pid',
    new CreateVoucherRequest([
        'rewardId' => 'rewardId',
    ]),
);
```

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

### blockNewDomain usage example

Source: https://github.com/getbrevo/brevo-php/blob/main/_autodocs/api-reference/transactional-emails.md

Example of blocking a new domain by passing a BlockNewDomainRequest with the domain set to 'spam.example.com'.

```php
use Brevo\TransactionalEmails\Requests\BlockNewDomainRequest;
$client->transactionalEmails->blockNewDomain(new BlockNewDomainRequest(['domain' => 'spam.example.com']));
```

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

### Usage example for deserializing and serializing

Source: https://github.com/getbrevo/brevo-php/blob/main/_autodocs/api-reference/serialization.md

Shows how to deserialize a response using GetAccountResponse::fromJson and serialize a request DTO using CreateContactRequest::toJson.

```php
// Deserializing a response
$response = GetAccountResponse::fromJson($responseBody);
echo $response->companyName;

// Serializing a request DTO
$json = (new CreateContactRequest(['email' => 'a@b.co']))->toJson();
```

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

### createWhatsAppTemplate: Create a WhatsApp template

Source: https://github.com/getbrevo/brevo-php/blob/main/reference.md

Creates a WhatsApp template. Requires a WhatsApp account set up on the Brevo platform.

```php
$client->whatsAppCampaigns->createWhatsAppTemplate(
    new CreateWhatsAppTemplateRequest([
        'bodyText' => 'making it look like readable English',
        'category' => CreateWhatsAppTemplateRequestCategory::Marketing->value,
        'language' => 'en',
        'name' => 'Test template',
    ]),
);
```

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

### Create loyalty program with createNewLp

Source: https://github.com/getbrevo/brevo-php/blob/main/reference.md

Creates a loyalty program. The request requires a 'name' (max 128 chars) and accepts optional $description (max 256 chars), $documentId, and $meta.

```php
$client->program->createNewLp(
    new CreateNewLpRequest([
        'name' => 'name',
    ]),
);
```

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

### Get voucher for a contact

Source: https://github.com/getbrevo/brevo-php/blob/main/reference.md

Gets a voucher for a contact. Requires the loyalty program ID and a GetLoyaltyOfferProgramsPidVouchersRequest object with the contact ID.

```php
$client->reward->getVoucherForAContact(
    'pid',
    new GetLoyaltyOfferProgramsPidVouchersRequest([
        'contactId' => 1,
    ]),
);
```

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

### Upload file with File::createFromFilepath

Source: https://github.com/getbrevo/brevo-php/blob/main/_autodocs/api-reference/serialization.md

Example of uploading a file using File::createFromFilepath and the files->uploadAFile endpoint. The file is closed after the request.

```php
use Brevo\Utils\File;
use Brevo\Files\Requests\PostCrmFilesRequest;

$file = File::createFromFilepath('/tmp/report.pdf', filename: 'report.pdf', contentType: 'application/pdf');
$client->files->uploadAFile(new PostCrmFilesRequest(['file' => $file]));   // multipart POST crm/files
$file->close();
```

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

### Get Balance Definition List with getBalanceDefinitionList

Source: https://github.com/getbrevo/brevo-php/blob/main/reference.md

Returns a paginated list of balance definitions for a loyalty program. Requires the loyalty program ID and an empty request object.

```php
$client->balance->getBalanceDefinitionList(
    'pid',
    new GetBalanceDefinitionListRequest([]),
);
```

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

### $client->deals->getAllPipelines()

Source: https://github.com/getbrevo/brevo-php/blob/main/reference.md

Retrieves the list of all deal pipelines configured for the account, including each pipeline's stages and settings. If no pipelines exist, a default pipeline is automatically created and returned.

```APIDOC
## $client->deals->getAllPipelines()

### Description
Retrieves the list of all deal pipelines configured for the account, including each pipeline's stages and settings. If no pipelines exist, a default pipeline is automatically created and returned.

### Method
GET

### Endpoint
/crm/pipelines

### Parameters
None

### Request Example
```php
$client->deals->getAllPipelines();
```

### Response
#### Success Response (200)
- **array** (?array) - List of pipelines.

#### Response Example
No response example provided.

```

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

### Example: sendTransacSms usage

Source: https://github.com/getbrevo/brevo-php/blob/main/_autodocs/api-reference/transactional-sms.md

Example of sending a transactional SMS using the SendTransacSms DTO with recipient, sender, content, type, and webUrl.

```php
use Brevo\Types\SendTransacSms;
use Brevo\Types\SendTransacSmsType;

$client->transactionalSms->sendTransacSms(
    new SendTransacSms([
        'recipient' => '+33612345678',
        'sender' => 'MyStore',
        'content' => 'Your order #1234 shipped!',
        'type' => SendTransacSmsType::Transactional->value,
        'webUrl' => 'https://example.com/sms-webhook',
    ]),
);
```

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

### $client->program->getLpList($request) -> ?GetLpListResponse

Source: https://github.com/getbrevo/brevo-php/blob/main/reference.md

Returns a list of loyalty programs. Supports pagination and sorting parameters.

```APIDOC
## $client->program->getLpList($request) -> ?GetLpListResponse

### Description
Returns list of loyalty programs

### Method
GET

### Endpoint
$client->program->getLpList

### Parameters
#### Query Parameters
- **$limit** (?int) - Optional - Number of documents per page
- **$offset** (?int) - Optional - Index of the first document in the page
- **$sortField** (?string) - Optional - Sort documents by field
- **$sort** (?string) - Optional - Sort order

### Request Example
```php
$client->program->getLpList(
    new GetLpListRequest([]),
);
```

### Response
#### Success Response (200)
- **GetLpListResponse** - The response object containing the list of loyalty programs

#### Response Example
```php
?GetLpListResponse
```
```

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

### $client->ecommerce->activateTheECommerceApp()

Source: https://github.com/getbrevo/brevo-php/blob/main/reference.md

Activates the Brevo eCommerce app to gain access to eCommerce features.

```APIDOC
## $client->ecommerce->activateTheECommerceApp()

### Description
Activates the Brevo eCommerce app to gain access to eCommerce features.

### Method
POST

### Endpoint
/ecommerce/activate

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
```php
$client->ecommerce->activateTheECommerceApp();
```

### Response
#### Success Response (200)
No response body documented.

#### Response Example
No response example documented.
```

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

### Get shared template URL with getSharedTemplateUrl

Source: https://github.com/getbrevo/brevo-php/blob/main/reference.md

Gets a unique URL to share and import an email template from one Brevo account to another. The campaignId parameter is the id of the campaign or template.

```php
$client->emailCampaigns->getSharedTemplateUrl(
    1000000,
);
```

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

### Get transactional email content by UUID

Source: https://github.com/getbrevo/brevo-php/blob/main/reference.md

Retrieves the content of a transactional email by its UUID. The UUID can be obtained by sending a GET request to https://api.brevo.com/v3/smtp/emails with the message_id, or from the transactional logs page in your Brevo account.

```php
$client->transactionalEmails->getTransacEmailContent(
    'uuid',
);
```

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

### Pin Brevo PHP SDK to v4.x

Source: https://github.com/getbrevo/brevo-php/blob/main/README.md

Use this command to pin the SDK to v4.x if you need to stay on the older major version while v5 is released.

```bash
composer require getbrevo/brevo-php:^4.0
```

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

### Brevo\Brevo::__construct

Source: https://github.com/getbrevo/brevo-php/blob/main/_autodocs/api-reference/brevo.md

Constructor for the Brevo client. Accepts an API key and optional configuration options, and initializes the HTTP stack and all resource clients.

```APIDOC
## Constructor

### Description
Creates a new Brevo client instance with the provided API key and optional configuration.

### Method
Constructor

### Endpoint
`new Brevo(string $apiKey, ?array $options = null)`

### Parameters
- **apiKey** (string) - Required - API key sent as the `api-key` header on every request.
- **options** (?array) - Optional - Optional client configuration. Supported keys: `baseUrl` (string), `client` (ClientInterface), `maxRetries` (int), `timeout` (float), `headers` (array<string, string>).

### Request Example
```php
use Brevo\Brevo;

$client = new Brevo(
    apiKey: 'xkeysib-0000000000000000000000000000000000000000000000000000000000000000',
);
```

### Response
No return value. The constructor initializes the client and its sub-clients.

### Notes
- User-supplied `headers` override the default headers (`api-key`, `X-Fern-Language`, `X-Fern-SDK-Name`, `X-Fern-SDK-Version`, `User-Agent`).
- If no `client` is provided, a PSR-18 client is discovered via `php-http/discovery`.
- `timeout` is only applicable to Guzzle/Symfony clients.
- `maxRetries` defaults to 2.
- `baseUrl` defaults to `https://api.brevo.com/v3`.
```

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

### GET /crm/files

Source: https://github.com/getbrevo/brevo-php/blob/main/_autodocs/endpoints-part2.md

Retrieves all files.

```APIDOC
## GET /crm/files

### Description
Retrieves a list of all files.

### Method
GET

### Endpoint
/crm/files

### Response
#### Success Response (200)
- **array** - The list of files.

#### Response Example
```json
[]
```
```

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

### GET /crm/notes

Source: https://github.com/getbrevo/brevo-php/blob/main/_autodocs/endpoints-part2.md

Retrieves all notes.

```APIDOC
## GET /crm/notes

### Description
Retrieves a list of all notes.

### Method
GET

### Endpoint
/crm/notes

### Response
#### Success Response (200)
- **array** - The list of notes.

#### Response Example
```json
[]
```
```

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

### POST products/batch

Source: https://github.com/getbrevo/brevo-php/blob/main/_autodocs/endpoints.md

Creates or updates multiple products in a batch.

```APIDOC
## POST products/batch

### Description
Creates or updates multiple products in a batch.

### Method
POST

### Endpoint
products/batch

### Request Body
- **products** (array of objects) - Required - The list of products to create or update.

### Request Example
```json
{
  "products": [
    {
      "id": "prod123",
      "name": "Laptop",
      "price": 999.99
    }
  ]
}
```

### Response
#### Success Response (200)
- **CreateUpdateBatchProductsResponse** - The response containing the batch result.

#### Response Example
```json
{
  "updatedCount": 1
}
```
```

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

### GET /crm/tasks

Source: https://github.com/getbrevo/brevo-php/blob/main/_autodocs/endpoints-part2.md

Retrieves all tasks.

```APIDOC
## GET /crm/tasks

### Description
Retrieves a list of all tasks.

### Method
GET

### Endpoint
/crm/tasks

### Response
#### Success Response (200)
- **GetCrmTasksResponse** - The response object containing the list of tasks.

#### Response Example
```json
{
  "tasks": []
}
```
```

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

### $client->reward->createVoucher($pid, $request) -> ?CreateVoucherResponse

Source: https://github.com/getbrevo/brevo-php/blob/main/reference.md

Creates a voucher and attributes it to a specific membership within a loyalty program. Requires the loyalty program ID and a request body with voucher details.

```APIDOC
## $client->reward->createVoucher($pid, $request) -> ?CreateVoucherResponse

### Description
Create a voucher and attribute it to a specific membership.

### Method
POST

### Endpoint
/loyalty/programs/{pid}/vouchers

### Parameters
#### Path Parameters
- **$pid** (string) - Required - Loyalty Program ID

#### Request Body
- **$code** (?string) - Optional - Code generated to attribute reward to a contact
- **$contactId** (?int) - Optional - Contact to attribute the reward
- **$expirationDate** (?string) - Optional - Reward expiration date
- **$loyaltySubscriptionId** (?string) - Optional - One of contactId or loyaltySubscriptionId is required
- **$meta** (?array) - Optional - Offer meta information (key/value object)
- **$rewardId** (string) - Required - Reward id
- **$value** (?float) - Optional - Value of the selected reward config
- **$validFrom** (?string) - Optional - Date from which the voucher becomes valid. Accepts RFC 3339 or DD/MM/YYYY HH:MM AM/PM format. Converted to UTC using the organization's timezone.

### Request Example
```php
$client->reward->createVoucher(
    'pid',
    new CreateVoucherRequest([
        'rewardId' => 'rewardId',
    ]),
);
```

### Response
#### Success Response (200)
- **CreateVoucherResponse** - The response object containing the created voucher.

#### Response Example
```json
{
  "id": "voucher_id"
}
```
```

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

### $client->balance->createBalanceDefinition($pid, $request) -> ?BalanceDefinition

Source: https://github.com/getbrevo/brevo-php/blob/main/reference.md

Creates a new balance definition for a loyalty program and returns the created definition. Requires a name and unit, with many optional fields for balance behavior and metadata.

```APIDOC
## $client->balance->createBalanceDefinition($pid, $request) -> ?BalanceDefinition

### Description
Creates balance definition and returns information

### Method
PHP SDK Method

### Endpoint
$client->balance->createBalanceDefinition($pid, $request)

### Parameters
#### Path Parameters
- **$pid** (string) - Required - Loyalty Program Id

#### Request Body
- **$balanceAvailabilityDurationModifier** (?string) - Optional - Defines when the balance expires within the selected duration.
- **$balanceAvailabilityDurationUnit** (?string) - Optional - Unit of time for balance validity.
- **$balanceAvailabilityDurationValue** (?int) - Optional - Number of time units before the balance expires.
- **$balanceExpirationDate** (?DateTime) - Optional - Fixed expiration date (`dd/mm` format) as an alternative to duration-based expiry.
- **$balanceOptionAmountOvertakingStrategy** (?string) - Optional - Defines whether partial credit is allowed when reaching max balance.
- **$balanceOptionCreditRounding** (?string) - Optional - Defines rounding strategy for credit transactions.
- **$balanceOptionDebitRounding** (?string) - Optional - Defines rounding strategy for debit transactions.
- **$description** (?string) - Optional - Short description of the balance definition.
- **$imageRef** (?string) - Optional - URL of an optional image reference.
- **$maxAmount** (?float) - Optional - Maximum allowable balance amount.
- **$maxCreditAmountLimit** (?float) - Optional - Maximum credit allowed per operation.
- **$maxDebitAmountLimit** (?float) - Optional - Maximum debit allowed per operation.
- **$meta** (?PostLoyaltyBalanceProgramsPidBalanceDefinitionsRequestMeta) - Optional - Additional metadata for the balance definition.
- **$minAmount** (?float) - Optional - Minimum allowable balance amount.
- **$name** (string) - Required - Name of the balance definition.
- **$unit** (string) - Required - Unit of balance measurement.

### Request Example
```php
$client->balance->createBalanceDefinition(
    'pid',
    new PostLoyaltyBalanceProgramsPidBalanceDefinitionsRequest([
        'name' => 'name',
        'unit' => PostLoyaltyBalanceProgramsPidBalanceDefinitionsRequestUnit::Points->value,
    ]),
);
```

### Response
#### Success Response
- **BalanceDefinition** - The created balance definition object.

#### Response Example
```php
?BalanceDefinition
```
```

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

### GET /crm/deals

Source: https://github.com/getbrevo/brevo-php/blob/main/_autodocs/endpoints-part2.md

Retrieves all deals.

```APIDOC
## GET /crm/deals

### Description
Retrieves a list of all deals.

### Method
GET

### Endpoint
/crm/deals

### Response
#### Success Response (200)
- **GetCrmDealsResponse** - The response object containing the list of deals.

#### Response Example
```json
{
  "deals": []
}
```
```

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

### GET /companies

Source: https://github.com/getbrevo/brevo-php/blob/main/_autodocs/endpoints-part2.md

Retrieves all companies.

```APIDOC
## GET /companies

### Description
Retrieves a list of all companies.

### Method
GET

### Endpoint
/companies

### Response
#### Success Response (200)
- **GetCompaniesResponse** - The response object containing the list of companies.

#### Response Example
```json
{
  "companies": []
}
```
```

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

### Get all domains with getDomains()

Source: https://github.com/getbrevo/brevo-php/blob/main/reference.md

Retrieves all domains associated with the account. Use to list domains, verify existence, check authentication and verification status, monitor configuration and provider information, and review creation history. Returns domain details, verification states, IP addresses, DNS providers, creator info, and pagination information.

```php
$client->domains->getDomains();
```

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

### $client->balance->getBalanceDefinitionList($pid, $request) -> ?GetBalanceDefinitionListResponse

Source: https://github.com/getbrevo/brevo-php/blob/main/reference.md

Returns a paginated list of balance definitions for a loyalty program. Supports pagination, sorting, and version filtering.

```APIDOC
## $client->balance->getBalanceDefinitionList($pid, $request) -> ?GetBalanceDefinitionListResponse

### Description
Returns balance definition page

### Method
PHP SDK Method

### Endpoint
$client->balance->getBalanceDefinitionList($pid, $request)

### Parameters
#### Path Parameters
- **$pid** (string) - Required - Loyalty Program Id

#### Query Parameters
- **$limit** (?int) - Optional - Limit the number of records returned
- **$offset** (?int) - Optional - Offset to paginate records
- **$sortField** (?string) - Optional - Field to sort by
- **$sort** (?string) - Optional - Sort direction
- **$version** (?string) - Optional - Version

### Request Example
```php
$client->balance->getBalanceDefinitionList(
    'pid',
    new GetBalanceDefinitionListRequest([]),
);
```

### Response
#### Success Response
- **GetBalanceDefinitionListResponse** - The response object containing a list of balance definitions.

#### Response Example
```php
?GetBalanceDefinitionListResponse
```
```

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

### Get code count with $client->reward->getCodeCount

Source: https://github.com/getbrevo/brevo-php/blob/main/reference.md

Calls the reward API to get the code count for a loyalty program and code pool. Requires the loyalty program ID and code pool ID as string parameters.

```php
$client->reward->getCodeCount(
    'pid',
    'cpid',
);
```

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

### Get webhook details with getWebhook

Source: https://github.com/getbrevo/brevo-php/blob/main/reference.md

Retrieves detailed information about a specific webhook configuration. Use this to get complete webhook details, event subscriptions, authentication settings, custom headers, and status. The $webhookId parameter is required.

```php
$client->webhooks->getWebhook(
    1000000,
);
```

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

### AccountClient constructor

Source: https://github.com/getbrevo/brevo-php/blob/main/_autodocs/api-reference/account.md

Constructor for AccountClient. It is built by the Brevo client and not intended for direct construction.

```php
// src/Account/AccountClient.php:72
public function __construct(
    RawClient $client,
    ?array $options = null,
)
```

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

### GET orders

Source: https://github.com/getbrevo/brevo-php/blob/main/_autodocs/endpoints.md

Retrieves the list of orders.

```APIDOC
## GET orders

### Description
Retrieves the list of orders.

### Method
GET

### Endpoint
orders

### Response
#### Success Response (200)
- **mixed** - The response containing the list of orders.

#### Response Example
```json
{
  "orders": []
}
```
```

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

### GET categories

Source: https://github.com/getbrevo/brevo-php/blob/main/_autodocs/endpoints.md

Retrieves the list of categories.

```APIDOC
## GET categories

### Description
Retrieves the list of categories.

### Method
GET

### Endpoint
categories

### Response
#### Success Response (200)
- **GetCategoriesResponse** - The response containing the list of categories.

#### Response Example
```json
{
  "categories": []
}
```
```

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

### GET events

Source: https://github.com/getbrevo/brevo-php/blob/main/_autodocs/endpoints.md

Retrieves the list of events.

```APIDOC
## GET events

### Description
Retrieves the list of events.

### Method
GET

### Endpoint
events

### Response
#### Success Response (200)
- **GetEventsList** - The response containing the list of events.

#### Response Example
```json
{
  "events": []
}
```
```

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

### $client->balance->beginTransaction($pid, $request) -> ?Transaction

Source: https://github.com/getbrevo/brevo-php/blob/main/reference.md

Creates a new transaction and returns information about it. The request body must include the amount and balanceDefinitionId, with optional fields for transaction type, contact, loyalty subscription, metadata, TTL, event time, auto-complete, and balance expiry.

```APIDOC
## $client->balance->beginTransaction($pid, $request) -> ?Transaction

### Description
Creates a new transaction and returns information about it.

### Method
POST

### Endpoint
/balance/transactions

### Parameters
#### Path Parameters
- **$pid** (string) - Required - Loyalty Program Id

#### Request Body
- **$amount** (float) - Required - Transaction amount. A positive value creates a credit transaction and a negative value creates a debit transaction (unless transactionType is explicitly provided).
- **$transactionType** (?string) - Optional - Explicit transaction type. If not provided, the type is inferred from the sign of the amount (positive = credit, negative = debit).
- **$balanceDefinitionId** (string) - Required - Unique identifier (UUID) of the associated balance definition.
- **$contactId** (?int) - Optional - Unique identifier of the contact involved in the transaction. Required unless `LoyaltySubscriptionId` is provided.
- **$loyaltySubscriptionId** (?string) - Optional - Unique identifier for the loyalty subscription. Required unless `contactId` is provided.
- **$meta** (?array) - Optional - Optional metadata associated with the transaction.
- **$ttl** (?int) - Optional - Time-to-live for the transaction in seconds. Must be at least 10 seconds if provided.
- **$eventTime** (?DateTime) - Optional - Timestamp specifying when the transaction event occurred (ISO 8601 / RFC 3339 format).
- **$autoComplete** (?bool) - Optional - Whether the transaction should be automatically completed.
- **$balanceExpiryInMinutes** (?int) - Optional - Expiry time for the balance in minutes. Must be greater than 0 if provided. Only applicable when autoComplete is true.

### Request Example
```php
$client->balance->beginTransaction(
    'pid',
    new BeginTransactionRequest([
        'amount' => 1.1,
        'balanceDefinitionId' => 'balanceDefinitionId',
    ]),
);
```

### Response
#### Success Response (200)
- **id** (string) - Transaction ID
- **amount** (float) - Transaction amount
- **balanceDefinitionId** (string) - Balance definition ID
- **contactId** (int) - Contact ID
- **loyaltySubscriptionId** (string) - Loyalty subscription ID
- **status** (string) - Transaction status
- **transactionType** (string) - Transaction type
- **createdAt** (string) - Creation timestamp

#### Response Example
```json
{
  "id": "transaction-id",
  "amount": 1.1,
  "balanceDefinitionId": "balance-definition-id",
  "contactId": 123,
  "loyaltySubscriptionId": "loyalty-subscription-id",
  "status": "pending",
  "transactionType": "credit",
  "createdAt": "2023-01-01T00:00:00Z"
}
```
```

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

### GET webhooks

Source: https://github.com/getbrevo/brevo-php/blob/main/_autodocs/endpoints.md

Retrieves the list of webhooks.

```APIDOC
## GET webhooks

### Description
Retrieves the list of webhooks.

### Method
GET

### Endpoint
webhooks

### Response
#### Success Response (200)
- **GetWebhooksResponse** - The response containing the list of webhooks.

#### Response Example
```json
{
  "webhooks": []
}
```
```

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

### Create Product Alert: createProductAlert

Source: https://github.com/getbrevo/brevo-php/blob/main/reference.md

Registers a contact to receive alerts for a product event like back_in_stock. Requires at least one of ext_id, email, or sms; priority ext_id > email > sms. Returns 404 if product missing, 403 if alerts not enabled.

```php
$client->ecommerce->createProductAlert(
    'id',
    'back_in_stock',
    new CreateProductAlertRequest([]),
);
```

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

### Create Balance Definition with createBalanceDefinition

Source: https://github.com/getbrevo/brevo-php/blob/main/reference.md

Creates a balance definition and returns its information. Requires the loyalty program ID and a request object with name and unit (e.g., Points).

```php
$client->balance->createBalanceDefinition(
    'pid',
    new PostLoyaltyBalanceProgramsPidBalanceDefinitionsRequest([
        'name' => 'name',
        'unit' => PostLoyaltyBalanceProgramsPidBalanceDefinitionsRequestUnit::Points->value,
    ]),
);
```

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

### POST /loyalty/balance/programs/{$pid}/subscriptions/{$cid}/balances

Source: https://github.com/getbrevo/brevo-php/blob/main/_autodocs/endpoints-part2.md

Creates balances for a specific subscription.

```APIDOC
## POST /loyalty/balance/programs/{$pid}/subscriptions/{$cid}/balances

### Description
Creates balances for a specific subscription.

### Method
POST

### Endpoint
`/loyalty/balance/programs/{$pid}/subscriptions/{$cid}/balances`

### Parameters
#### Path Parameters
- **pid** (string) - Required - The loyalty program ID.
- **cid** (string) - Required - The subscription ID.

### Response
#### Success Response (200)
- **PostLoyaltyBalanceProgramsPidSubscriptionsCidBalancesResponse** - The created subscription balances response.

```

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

### GET /contacts/attributes

Source: https://github.com/getbrevo/brevo-php/blob/main/_autodocs/endpoints.md

Retrieves all contact attributes.

```APIDOC
## GET /contacts/attributes

### Description
Retrieves all contact attributes.

### Method
GET

### Endpoint
`/contacts/attributes`

### Response
#### Success Response (200)
- **GetAttributesResponse** (object) - The list of attributes.

#### Response Example
```json
{
  "attributes": [
    {
      "name": "FIRSTNAME",
      "category": "normal",
      "type": "text",
      "enumeration": [],
      "calculatedValue": null
    }
  ]
}
```
```

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

### GET /contacts

Source: https://github.com/getbrevo/brevo-php/blob/main/_autodocs/endpoints.md

Retrieves a list of contacts.

```APIDOC
## GET /contacts

### Description
Retrieves a list of contacts.

### Method
GET

### Endpoint
`/contacts`

### Response
#### Success Response (200)
- **GetContacts** (object) - The list of contacts.

#### Response Example
```json
{
  "contacts": [
    {
      "email": "john.doe@example.com",
      "id": 1,
      "emailBlacklisted": false,
      "smsBlacklisted": false,
      "createdAt": "2023-01-01T00:00:00Z",
      "modifiedAt": "2023-01-01T00:00:00Z",
      "listIds": [1, 2],
      "listUnsubscribed": [],
      "attributes": {}
    }
  ],
  "count": 1
}
```
```

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

### POST /loyalty/balance/programs/{$pid}/create-order

Source: https://github.com/getbrevo/brevo-php/blob/main/_autodocs/endpoints-part2.md

Creates a balance order for a loyalty program.

```APIDOC
## POST /loyalty/balance/programs/{$pid}/create-order

### Description
Creates a balance order for a loyalty program.

### Method
POST

### Endpoint
`/loyalty/balance/programs/{$pid}/create-order`

### Parameters
#### Path Parameters
- **pid** (string) - Required - The loyalty program ID.

### Response
#### Success Response (200)
- **CreateBalanceOrderResponse** - The created balance order response.

```

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

### GET /senders/domains

Source: https://github.com/getbrevo/brevo-php/blob/main/_autodocs/endpoints-part2.md

Retrieves all sender domains.

```APIDOC
## GET /senders/domains

### Description
Retrieves a list of all sender domains.

### Method
GET

### Endpoint
/senders/domains

### Response
#### Success Response (200)
- **GetDomainsResponse** - The response object containing the list of domains.

#### Response Example
```json
{
  "domains": []
}
```
```

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

### Get Product Info: getProductInfo

Source: https://github.com/getbrevo/brevo-php/blob/main/reference.md

Retrieves full details of a single product by ID, including name, price, SKU, URL, images, categories, stock, meta info, timestamps, and deletion status. Returns 404 if product not found.

```php
$client->ecommerce->getProductInfo(
    'id',
);
```

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

### GET /crm/tasktypes

Source: https://github.com/getbrevo/brevo-php/blob/main/_autodocs/endpoints-part2.md

Retrieves all task types.

```APIDOC
## GET /crm/tasktypes

### Description
Retrieves all task types.

### Method
GET

### Endpoint
/crm/tasktypes

### Response
#### Success Response (200)
- **array** - The list of task types.

#### Response Example
```json
[]
```
```
Tokens:
Raw