Brevo\Client\ResellerApi

All URIs are relative to https://api.brevo.com/v3

Method	HTTP request	Description
addCredits	POST /reseller/children/{childIdentifier}/credits/add	Add Email and/or SMS credits to a specific child account
associateIpToChild	POST /reseller/children/{childIdentifier}/ips/associate	Associate a dedicated IP to the child
createChildDomain	POST /reseller/children/{childIdentifier}/domains	Create a domain for a child account
createResellerChild	POST /reseller/children	Creates a reseller child
deleteChildDomain	DELETE /reseller/children/{childIdentifier}/domains/{domainName}	Delete the sender domain of the reseller child based on the childIdentifier and domainName passed
deleteResellerChild	DELETE /reseller/children/{childIdentifier}	Delete a single reseller child based on the child identifier supplied
dissociateIpFromChild	POST /reseller/children/{childIdentifier}/ips/dissociate	Dissociate a dedicated IP to the child
getChildAccountCreationStatus	GET /reseller/children/{childIdentifier}/accountCreationStatus	Get the status of a reseller's child account creation, whether it is successfully created (exists) or not based on the identifier supplied
getChildDomains	GET /reseller/children/{childIdentifier}/domains	Get all sender domains for a specific child account
getChildInfo	GET /reseller/children/{childIdentifier}	Get a child account's details
getResellerChilds	GET /reseller/children	Get the list of all children accounts
getSsoToken	GET /reseller/children/{childIdentifier}/auth	Get session token to access Brevo (SSO)
removeCredits	POST /reseller/children/{childIdentifier}/credits/remove	Remove Email and/or SMS credits from a specific child account
updateChildAccountStatus	PUT /reseller/children/{childIdentifier}/accountStatus	Update info of reseller's child account status based on the childIdentifier supplied
updateChildDomain	PUT /reseller/children/{childIdentifier}/domains/{domainName}	Update the sender domain of reseller's child based on the childIdentifier and domainName passed
updateResellerChild	PUT /reseller/children/{childIdentifier}	Update info of reseller's child based on the child identifier supplied

addCredits

\Brevo\Client\Model\RemainingCreditModel addCredits($childIdentifier, $addCredits)

Add Email and/or SMS credits to a specific child account

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api-key
$config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer');
// Configure API key authorization: partner-key
$config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer');

$apiInstance = new Brevo\Client\Api\ResellerApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$childIdentifier = "childIdentifier_example"; // string | Either auth key or id of reseller's child
$addCredits = new \Brevo\Client\Model\AddCredits(); // \Brevo\Client\Model\AddCredits | Values to post to add credit to a specific child account

try {
    $result = $apiInstance->addCredits($childIdentifier, $addCredits);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ResellerApi->addCredits: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
childIdentifier	string	Either auth key or id of reseller's child
addCredits	\Brevo\Client\Model\AddCredits	Values to post to add credit to a specific child account

Return type

\Brevo\Client\Model\RemainingCreditModel

Authorization

api-key, partner-key

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

associateIpToChild

associateIpToChild($childIdentifier, $ip)

Associate a dedicated IP to the child

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api-key
$config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer');
// Configure API key authorization: partner-key
$config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer');

$apiInstance = new Brevo\Client\Api\ResellerApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$childIdentifier = "childIdentifier_example"; // string | Either auth key or id of reseller's child
$ip = new \Brevo\Client\Model\ManageIp(); // \Brevo\Client\Model\ManageIp | IP to associate

try {
    $apiInstance->associateIpToChild($childIdentifier, $ip);
} catch (Exception $e) {
    echo 'Exception when calling ResellerApi->associateIpToChild: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
childIdentifier	string	Either auth key or id of reseller's child
ip	\Brevo\Client\Model\ManageIp	IP to associate

Return type

void (empty response body)

Authorization

api-key, partner-key

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

createChildDomain

createChildDomain($childIdentifier, $addChildDomain)

Create a domain for a child account

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api-key
$config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer');
// Configure API key authorization: partner-key
$config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer');

$apiInstance = new Brevo\Client\Api\ResellerApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$childIdentifier = "childIdentifier_example"; // string | Either auth key or id of reseller's child
$addChildDomain = new \Brevo\Client\Model\AddChildDomain(); // \Brevo\Client\Model\AddChildDomain | Sender domain to add for a specific child account. This will not be displayed to the parent account.

try {
    $apiInstance->createChildDomain($childIdentifier, $addChildDomain);
} catch (Exception $e) {
    echo 'Exception when calling ResellerApi->createChildDomain: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
childIdentifier	string	Either auth key or id of reseller's child
addChildDomain	\Brevo\Client\Model\AddChildDomain	Sender domain to add for a specific child account. This will not be displayed to the parent account.

Return type

void (empty response body)

Authorization

api-key, partner-key

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

createResellerChild

\Brevo\Client\Model\CreateReseller createResellerChild($resellerChild)

Creates a reseller child

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api-key
$config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer');
// Configure API key authorization: partner-key
$config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer');

$apiInstance = new Brevo\Client\Api\ResellerApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$resellerChild = new \Brevo\Client\Model\CreateChild(); // \Brevo\Client\Model\CreateChild | reseller child to add

try {
    $result = $apiInstance->createResellerChild($resellerChild);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ResellerApi->createResellerChild: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
resellerChild	\Brevo\Client\Model\CreateChild	reseller child to add	[optional]

Return type

\Brevo\Client\Model\CreateReseller

Authorization

api-key, partner-key

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

deleteChildDomain

deleteChildDomain($childIdentifier, $domainName)

Delete the sender domain of the reseller child based on the childIdentifier and domainName passed

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api-key
$config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer');
// Configure API key authorization: partner-key
$config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer');

$apiInstance = new Brevo\Client\Api\ResellerApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$childIdentifier = "childIdentifier_example"; // string | Either auth key or id of reseller's child
$domainName = "domainName_example"; // string | Pass the existing domain that needs to be deleted

try {
    $apiInstance->deleteChildDomain($childIdentifier, $domainName);
} catch (Exception $e) {
    echo 'Exception when calling ResellerApi->deleteChildDomain: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
childIdentifier	string	Either auth key or id of reseller's child
domainName	string	Pass the existing domain that needs to be deleted

Return type

void (empty response body)

Authorization

api-key, partner-key

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

deleteResellerChild

deleteResellerChild($childIdentifier)

Delete a single reseller child based on the child identifier supplied

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api-key
$config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer');
// Configure API key authorization: partner-key
$config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer');

$apiInstance = new Brevo\Client\Api\ResellerApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$childIdentifier = "childIdentifier_example"; // string | Either auth key or child id of reseller's child

try {
    $apiInstance->deleteResellerChild($childIdentifier);
} catch (Exception $e) {
    echo 'Exception when calling ResellerApi->deleteResellerChild: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
childIdentifier	string	Either auth key or child id of reseller's child

Return type

void (empty response body)

Authorization

api-key, partner-key

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

dissociateIpFromChild

dissociateIpFromChild($childIdentifier, $ip)

Dissociate a dedicated IP to the child

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api-key
$config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer');
// Configure API key authorization: partner-key
$config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer');

$apiInstance = new Brevo\Client\Api\ResellerApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$childIdentifier = "childIdentifier_example"; // string | Either auth key or id of reseller's child
$ip = new \Brevo\Client\Model\ManageIp(); // \Brevo\Client\Model\ManageIp | IP to dissociate

try {
    $apiInstance->dissociateIpFromChild($childIdentifier, $ip);
} catch (Exception $e) {
    echo 'Exception when calling ResellerApi->dissociateIpFromChild: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
childIdentifier	string	Either auth key or id of reseller's child
ip	\Brevo\Client\Model\ManageIp	IP to dissociate

Return type

void (empty response body)

Authorization

api-key, partner-key

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getChildAccountCreationStatus

\Brevo\Client\Model\GetChildAccountCreationStatus getChildAccountCreationStatus($childIdentifier)

Get the status of a reseller's child account creation, whether it is successfully created (exists) or not based on the identifier supplied

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api-key
$config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer');
// Configure API key authorization: partner-key
$config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer');

$apiInstance = new Brevo\Client\Api\ResellerApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$childIdentifier = "childIdentifier_example"; // string | Either auth key or id of reseller's child

try {
    $result = $apiInstance->getChildAccountCreationStatus($childIdentifier);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ResellerApi->getChildAccountCreationStatus: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
childIdentifier	string	Either auth key or id of reseller's child

Return type

\Brevo\Client\Model\GetChildAccountCreationStatus

Authorization

api-key, partner-key

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getChildDomains

\Brevo\Client\Model\GetChildDomains getChildDomains($childIdentifier)

Get all sender domains for a specific child account

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api-key
$config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer');
// Configure API key authorization: partner-key
$config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer');

$apiInstance = new Brevo\Client\Api\ResellerApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$childIdentifier = "childIdentifier_example"; // string | Either auth key or id of reseller's child

try {
    $result = $apiInstance->getChildDomains($childIdentifier);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ResellerApi->getChildDomains: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
childIdentifier	string	Either auth key or id of reseller's child

Return type

\Brevo\Client\Model\GetChildDomains

Authorization

api-key, partner-key

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getChildInfo

\Brevo\Client\Model\GetChildInfo getChildInfo($childIdentifier)

Get a child account's details

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api-key
$config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer');
// Configure API key authorization: partner-key
$config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer');

$apiInstance = new Brevo\Client\Api\ResellerApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$childIdentifier = "childIdentifier_example"; // string | Either auth key or id of reseller's child

try {
    $result = $apiInstance->getChildInfo($childIdentifier);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ResellerApi->getChildInfo: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
childIdentifier	string	Either auth key or id of reseller's child

Return type

\Brevo\Client\Model\GetChildInfo

Authorization

api-key, partner-key

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getResellerChilds

\Brevo\Client\Model\GetChildrenList getResellerChilds($limit, $offset)

Get the list of all children accounts

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api-key
$config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer');
// Configure API key authorization: partner-key
$config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer');

$apiInstance = new Brevo\Client\Api\ResellerApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$limit = 10; // int | Number of documents for child accounts information per page
$offset = 0; // int | Index of the first document in the page

try {
    $result = $apiInstance->getResellerChilds($limit, $offset);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ResellerApi->getResellerChilds: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
limit	int	Number of documents for child accounts information per page	[optional] [default to 10]
offset	int	Index of the first document in the page	[optional] [default to 0]

Return type

\Brevo\Client\Model\GetChildrenList

Authorization

api-key, partner-key

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getSsoToken

\Brevo\Client\Model\GetSsoToken getSsoToken($childIdentifier)

Get session token to access Brevo (SSO)

It returns a session [token] which will remain valid for a short period of time. A child account will be able to access a white-labeled section by using the following url pattern => https:/email.mydomain.com/login/sso?token=[token]

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api-key
$config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer');
// Configure API key authorization: partner-key
$config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer');

$apiInstance = new Brevo\Client\Api\ResellerApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$childIdentifier = "childIdentifier_example"; // string | Either auth key or id of reseller's child

try {
    $result = $apiInstance->getSsoToken($childIdentifier);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ResellerApi->getSsoToken: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
childIdentifier	string	Either auth key or id of reseller's child

Return type

\Brevo\Client\Model\GetSsoToken

Authorization

api-key, partner-key

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

removeCredits

\Brevo\Client\Model\RemainingCreditModel removeCredits($childIdentifier, $removeCredits)

Remove Email and/or SMS credits from a specific child account

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api-key
$config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer');
// Configure API key authorization: partner-key
$config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer');

$apiInstance = new Brevo\Client\Api\ResellerApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$childIdentifier = "childIdentifier_example"; // string | Either auth key or id of reseller's child
$removeCredits = new \Brevo\Client\Model\RemoveCredits(); // \Brevo\Client\Model\RemoveCredits | Values to post to remove email or SMS credits from a specific child account

try {
    $result = $apiInstance->removeCredits($childIdentifier, $removeCredits);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ResellerApi->removeCredits: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
childIdentifier	string	Either auth key or id of reseller's child
removeCredits	\Brevo\Client\Model\RemoveCredits	Values to post to remove email or SMS credits from a specific child account

Return type

\Brevo\Client\Model\RemainingCreditModel

Authorization

api-key, partner-key

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

updateChildAccountStatus

updateChildAccountStatus($childIdentifier, $updateChildAccountStatus)

Update info of reseller's child account status based on the childIdentifier supplied

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api-key
$config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer');
// Configure API key authorization: partner-key
$config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer');

$apiInstance = new Brevo\Client\Api\ResellerApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$childIdentifier = "childIdentifier_example"; // string | Either auth key or id of reseller's child
$updateChildAccountStatus = new \Brevo\Client\Model\UpdateChildAccountStatus(); // \Brevo\Client\Model\UpdateChildAccountStatus | values to update in child account status

try {
    $apiInstance->updateChildAccountStatus($childIdentifier, $updateChildAccountStatus);
} catch (Exception $e) {
    echo 'Exception when calling ResellerApi->updateChildAccountStatus: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
childIdentifier	string	Either auth key or id of reseller's child
updateChildAccountStatus	\Brevo\Client\Model\UpdateChildAccountStatus	values to update in child account status

Return type

void (empty response body)

Authorization

api-key, partner-key

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

updateChildDomain

updateChildDomain($childIdentifier, $domainName, $updateChildDomain)

Update the sender domain of reseller's child based on the childIdentifier and domainName passed

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api-key
$config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer');
// Configure API key authorization: partner-key
$config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer');

$apiInstance = new Brevo\Client\Api\ResellerApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$childIdentifier = "childIdentifier_example"; // string | Either auth key or id of reseller's child
$domainName = "domainName_example"; // string | Pass the existing domain that needs to be updated
$updateChildDomain = new \Brevo\Client\Model\UpdateChildDomain(); // \Brevo\Client\Model\UpdateChildDomain | value to update for sender domain

try {
    $apiInstance->updateChildDomain($childIdentifier, $domainName, $updateChildDomain);
} catch (Exception $e) {
    echo 'Exception when calling ResellerApi->updateChildDomain: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description
childIdentifier	string	Either auth key or id of reseller's child
domainName	string	Pass the existing domain that needs to be updated
updateChildDomain	\Brevo\Client\Model\UpdateChildDomain	value to update for sender domain

Return type

void (empty response body)

Authorization

api-key, partner-key

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

updateResellerChild

updateResellerChild($childIdentifier, $resellerChild)

Update info of reseller's child based on the child identifier supplied

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api-key
$config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer');
// Configure API key authorization: partner-key
$config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer');

$apiInstance = new Brevo\Client\Api\ResellerApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$childIdentifier = "childIdentifier_example"; // string | Either auth key or id of reseller's child
$resellerChild = new \Brevo\Client\Model\UpdateChild(); // \Brevo\Client\Model\UpdateChild | values to update in child profile

try {
    $apiInstance->updateResellerChild($childIdentifier, $resellerChild);
} catch (Exception $e) {
    echo 'Exception when calling ResellerApi->updateResellerChild: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
childIdentifier	string	Either auth key or id of reseller's child
resellerChild	\Brevo\Client\Model\UpdateChild	values to update in child profile

Return type

void (empty response body)

Authorization

api-key, partner-key

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Files

ResellerApi.md

Latest commit

History

ResellerApi.md

File metadata and controls

Brevo\Client\ResellerApi

addCredits

Example

Parameters

Return type

Authorization

HTTP request headers

associateIpToChild

Example

Parameters

Return type

Authorization

HTTP request headers

createChildDomain

Example

Parameters

Return type

Authorization

HTTP request headers

createResellerChild

Example

Parameters

Return type

Authorization

HTTP request headers

deleteChildDomain

Example

Parameters

Return type

Authorization

HTTP request headers

deleteResellerChild

Example

Parameters

Return type

Authorization

HTTP request headers

dissociateIpFromChild

Example

Parameters

Return type

Authorization

HTTP request headers

getChildAccountCreationStatus

Example

Parameters

Return type

Authorization

HTTP request headers

getChildDomains

Example

Parameters

Return type

Authorization

HTTP request headers

getChildInfo

Example

Parameters

Return type

Authorization

HTTP request headers

getResellerChilds

Example

Parameters

Return type

Authorization

HTTP request headers

getSsoToken

Example

Parameters

Return type

Authorization

HTTP request headers

removeCredits