brevo_python.ResellerApi

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

Method	HTTP request	Description
add_credits	POST /reseller/children/{childIdentifier}/credits/add	Add Email and/or SMS credits to a specific child account
associate_ip_to_child	POST /reseller/children/{childIdentifier}/ips/associate	Associate a dedicated IP to the child
create_child_domain	POST /reseller/children/{childIdentifier}/domains	Create a domain for a child account
create_reseller_child	POST /reseller/children	Creates a reseller child
delete_child_domain	DELETE /reseller/children/{childIdentifier}/domains/{domainName}	Delete the sender domain of the reseller child based on the childIdentifier and domainName passed
delete_reseller_child	DELETE /reseller/children/{childIdentifier}	Delete a single reseller child based on the child identifier supplied
dissociate_ip_from_child	POST /reseller/children/{childIdentifier}/ips/dissociate	Dissociate a dedicated IP to the child
get_child_account_creation_status	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
get_child_domains	GET /reseller/children/{childIdentifier}/domains	Get all sender domains for a specific child account
get_child_info	GET /reseller/children/{childIdentifier}	Get a child account's details
get_reseller_childs	GET /reseller/children	Get the list of all children accounts
get_sso_token	GET /reseller/children/{childIdentifier}/auth	Get session token to access Brevo (SSO)
remove_credits	POST /reseller/children/{childIdentifier}/credits/remove	Remove Email and/or SMS credits from a specific child account
update_child_account_status	PUT /reseller/children/{childIdentifier}/accountStatus	Update info of reseller's child account status based on the childIdentifier supplied
update_child_domain	PUT /reseller/children/{childIdentifier}/domains/{domainName}	Update the sender domain of reseller's child based on the childIdentifier and domainName passed
update_reseller_child	PUT /reseller/children/{childIdentifier}	Update info of reseller's child based on the child identifier supplied

add_credits

RemainingCreditModel add_credits(child_identifier, add_credits)

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

Example

from __future__ import print_function
import time
import brevo_python
from brevo_python.rest import ApiException
from pprint import pprint

# Configure API key authorization: api-key
configuration = brevo_python.Configuration()
configuration.api_key['api-key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['api-key'] = 'Bearer'
# Configure API key authorization: partner-key
configuration = brevo_python.Configuration()
configuration.api_key['partner-key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['partner-key'] = 'Bearer'

# create an instance of the API class
api_instance = brevo_python.ResellerApi(brevo_python.ApiClient(configuration))
child_identifier = 'child_identifier_example' # str | Either auth key or id of reseller's child
add_credits = brevo_python.AddCredits() # AddCredits | Values to post to add credit to a specific child account

try:
    # Add Email and/or SMS credits to a specific child account
    api_response = api_instance.add_credits(child_identifier, add_credits)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ResellerApi->add_credits: %s\n" % e)

Parameters

Name	Type	Description	Notes
child_identifier	str	Either auth key or id of reseller's child
add_credits	AddCredits	Values to post to add credit to a specific child account

Return type

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]

associate_ip_to_child

associate_ip_to_child(child_identifier, ip)

Associate a dedicated IP to the child

Example

from __future__ import print_function
import time
import brevo_python
from brevo_python.rest import ApiException
from pprint import pprint

# Configure API key authorization: api-key
configuration = brevo_python.Configuration()
configuration.api_key['api-key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['api-key'] = 'Bearer'
# Configure API key authorization: partner-key
configuration = brevo_python.Configuration()
configuration.api_key['partner-key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['partner-key'] = 'Bearer'

# create an instance of the API class
api_instance = brevo_python.ResellerApi(brevo_python.ApiClient(configuration))
child_identifier = 'child_identifier_example' # str | Either auth key or id of reseller's child
ip = brevo_python.ManageIp() # ManageIp | IP to associate

try:
    # Associate a dedicated IP to the child
    api_instance.associate_ip_to_child(child_identifier, ip)
except ApiException as e:
    print("Exception when calling ResellerApi->associate_ip_to_child: %s\n" % e)

Parameters

Name	Type	Description	Notes
child_identifier	str	Either auth key or id of reseller's child
ip	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]

create_child_domain

create_child_domain(child_identifier, add_child_domain)

Create a domain for a child account

Example

from __future__ import print_function
import time
import brevo_python
from brevo_python.rest import ApiException
from pprint import pprint

# Configure API key authorization: api-key
configuration = brevo_python.Configuration()
configuration.api_key['api-key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['api-key'] = 'Bearer'
# Configure API key authorization: partner-key
configuration = brevo_python.Configuration()
configuration.api_key['partner-key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['partner-key'] = 'Bearer'

# create an instance of the API class
api_instance = brevo_python.ResellerApi(brevo_python.ApiClient(configuration))
child_identifier = 'child_identifier_example' # str | Either auth key or id of reseller's child
add_child_domain = brevo_python.AddChildDomain() # AddChildDomain | Sender domain to add for a specific child account. This will not be displayed to the parent account.

try:
    # Create a domain for a child account
    api_instance.create_child_domain(child_identifier, add_child_domain)
except ApiException as e:
    print("Exception when calling ResellerApi->create_child_domain: %s\n" % e)

Parameters

Name	Type	Description	Notes
child_identifier	str	Either auth key or id of reseller's child
add_child_domain	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]

create_reseller_child

CreateReseller create_reseller_child(reseller_child=reseller_child)

Creates a reseller child

Example

from __future__ import print_function
import time
import brevo_python
from brevo_python.rest import ApiException
from pprint import pprint

# Configure API key authorization: api-key
configuration = brevo_python.Configuration()
configuration.api_key['api-key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['api-key'] = 'Bearer'
# Configure API key authorization: partner-key
configuration = brevo_python.Configuration()
configuration.api_key['partner-key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['partner-key'] = 'Bearer'

# create an instance of the API class
api_instance = brevo_python.ResellerApi(brevo_python.ApiClient(configuration))
reseller_child = brevo_python.CreateChild() # CreateChild | reseller child to add (optional)

try:
    # Creates a reseller child
    api_response = api_instance.create_reseller_child(reseller_child=reseller_child)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ResellerApi->create_reseller_child: %s\n" % e)

Parameters

Name	Type	Description	Notes
reseller_child	CreateChild	reseller child to add	[optional]

Return type

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]

delete_child_domain

delete_child_domain(child_identifier, domain_name)

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

Example

from __future__ import print_function
import time
import brevo_python
from brevo_python.rest import ApiException
from pprint import pprint

# Configure API key authorization: api-key
configuration = brevo_python.Configuration()
configuration.api_key['api-key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['api-key'] = 'Bearer'
# Configure API key authorization: partner-key
configuration = brevo_python.Configuration()
configuration.api_key['partner-key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['partner-key'] = 'Bearer'

# create an instance of the API class
api_instance = brevo_python.ResellerApi(brevo_python.ApiClient(configuration))
child_identifier = 'child_identifier_example' # str | Either auth key or id of reseller's child
domain_name = 'domain_name_example' # str | Pass the existing domain that needs to be deleted

try:
    # Delete the sender domain of the reseller child based on the childIdentifier and domainName passed
    api_instance.delete_child_domain(child_identifier, domain_name)
except ApiException as e:
    print("Exception when calling ResellerApi->delete_child_domain: %s\n" % e)

Parameters

Name	Type	Description	Notes
child_identifier	str	Either auth key or id of reseller's child
domain_name	str	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]

delete_reseller_child

delete_reseller_child(child_identifier)

Delete a single reseller child based on the child identifier supplied

Example

from __future__ import print_function
import time
import brevo_python
from brevo_python.rest import ApiException
from pprint import pprint

# Configure API key authorization: api-key
configuration = brevo_python.Configuration()
configuration.api_key['api-key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['api-key'] = 'Bearer'
# Configure API key authorization: partner-key
configuration = brevo_python.Configuration()
configuration.api_key['partner-key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['partner-key'] = 'Bearer'

# create an instance of the API class
api_instance = brevo_python.ResellerApi(brevo_python.ApiClient(configuration))
child_identifier = 'child_identifier_example' # str | Either auth key or child id of reseller's child

try:
    # Delete a single reseller child based on the child identifier supplied
    api_instance.delete_reseller_child(child_identifier)
except ApiException as e:
    print("Exception when calling ResellerApi->delete_reseller_child: %s\n" % e)

Parameters

Name	Type	Description	Notes
child_identifier	str	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]

dissociate_ip_from_child

dissociate_ip_from_child(child_identifier, ip)

Dissociate a dedicated IP to the child

Example

from __future__ import print_function
import time
import brevo_python
from brevo_python.rest import ApiException
from pprint import pprint

# Configure API key authorization: api-key
configuration = brevo_python.Configuration()
configuration.api_key['api-key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['api-key'] = 'Bearer'
# Configure API key authorization: partner-key
configuration = brevo_python.Configuration()
configuration.api_key['partner-key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['partner-key'] = 'Bearer'

# create an instance of the API class
api_instance = brevo_python.ResellerApi(brevo_python.ApiClient(configuration))
child_identifier = 'child_identifier_example' # str | Either auth key or id of reseller's child
ip = brevo_python.ManageIp() # ManageIp | IP to dissociate

try:
    # Dissociate a dedicated IP to the child
    api_instance.dissociate_ip_from_child(child_identifier, ip)
except ApiException as e:
    print("Exception when calling ResellerApi->dissociate_ip_from_child: %s\n" % e)

Parameters

Name	Type	Description	Notes
child_identifier	str	Either auth key or id of reseller's child
ip	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]

get_child_account_creation_status

GetChildAccountCreationStatus get_child_account_creation_status(child_identifier)

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

Example

from __future__ import print_function
import time
import brevo_python
from brevo_python.rest import ApiException
from pprint import pprint

# Configure API key authorization: api-key
configuration = brevo_python.Configuration()
configuration.api_key['api-key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['api-key'] = 'Bearer'
# Configure API key authorization: partner-key
configuration = brevo_python.Configuration()
configuration.api_key['partner-key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['partner-key'] = 'Bearer'

# create an instance of the API class
api_instance = brevo_python.ResellerApi(brevo_python.ApiClient(configuration))
child_identifier = 'child_identifier_example' # str | Either auth key or id of reseller's child

try:
    # Get the status of a reseller's child account creation, whether it is successfully created (exists) or not based on the identifier supplied
    api_response = api_instance.get_child_account_creation_status(child_identifier)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ResellerApi->get_child_account_creation_status: %s\n" % e)

Parameters

Name	Type	Description	Notes
child_identifier	str	Either auth key or id of reseller's child

Return type

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]

get_child_domains

GetChildDomains get_child_domains(child_identifier)

Get all sender domains for a specific child account

Example

from __future__ import print_function
import time
import brevo_python
from brevo_python.rest import ApiException
from pprint import pprint

# Configure API key authorization: api-key
configuration = brevo_python.Configuration()
configuration.api_key['api-key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['api-key'] = 'Bearer'
# Configure API key authorization: partner-key
configuration = brevo_python.Configuration()
configuration.api_key['partner-key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['partner-key'] = 'Bearer'

# create an instance of the API class
api_instance = brevo_python.ResellerApi(brevo_python.ApiClient(configuration))
child_identifier = 'child_identifier_example' # str | Either auth key or id of reseller's child

try:
    # Get all sender domains for a specific child account
    api_response = api_instance.get_child_domains(child_identifier)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ResellerApi->get_child_domains: %s\n" % e)

Parameters

Name	Type	Description	Notes
child_identifier	str	Either auth key or id of reseller's child

Return type

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]

get_child_info

GetChildInfo get_child_info(child_identifier)

Get a child account's details

Example

from __future__ import print_function
import time
import brevo_python
from brevo_python.rest import ApiException
from pprint import pprint

# Configure API key authorization: api-key
configuration = brevo_python.Configuration()
configuration.api_key['api-key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['api-key'] = 'Bearer'
# Configure API key authorization: partner-key
configuration = brevo_python.Configuration()
configuration.api_key['partner-key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['partner-key'] = 'Bearer'

# create an instance of the API class
api_instance = brevo_python.ResellerApi(brevo_python.ApiClient(configuration))
child_identifier = 'child_identifier_example' # str | Either auth key or id of reseller's child

try:
    # Get a child account's details
    api_response = api_instance.get_child_info(child_identifier)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ResellerApi->get_child_info: %s\n" % e)

Parameters

Name	Type	Description	Notes
child_identifier	str	Either auth key or id of reseller's child

Return type

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]

get_reseller_childs

GetChildrenList get_reseller_childs(limit=limit, offset=offset)

Get the list of all children accounts

Example

from __future__ import print_function
import time
import brevo_python
from brevo_python.rest import ApiException
from pprint import pprint

# Configure API key authorization: api-key
configuration = brevo_python.Configuration()
configuration.api_key['api-key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['api-key'] = 'Bearer'
# Configure API key authorization: partner-key
configuration = brevo_python.Configuration()
configuration.api_key['partner-key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['partner-key'] = 'Bearer'

# create an instance of the API class
api_instance = brevo_python.ResellerApi(brevo_python.ApiClient(configuration))
limit = 10 # int | Number of documents for child accounts information per page (optional) (default to 10)
offset = 0 # int | Index of the first document in the page (optional) (default to 0)

try:
    # Get the list of all children accounts
    api_response = api_instance.get_reseller_childs(limit=limit, offset=offset)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ResellerApi->get_reseller_childs: %s\n" % e)

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

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]

get_sso_token

GetSsoToken get_sso_token(child_identifier)

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

from __future__ import print_function
import time
import brevo_python
from brevo_python.rest import ApiException
from pprint import pprint

# Configure API key authorization: api-key
configuration = brevo_python.Configuration()
configuration.api_key['api-key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['api-key'] = 'Bearer'
# Configure API key authorization: partner-key
configuration = brevo_python.Configuration()
configuration.api_key['partner-key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['partner-key'] = 'Bearer'

# create an instance of the API class
api_instance = brevo_python.ResellerApi(brevo_python.ApiClient(configuration))
child_identifier = 'child_identifier_example' # str | Either auth key or id of reseller's child

try:
    # Get session token to access Brevo (SSO)
    api_response = api_instance.get_sso_token(child_identifier)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ResellerApi->get_sso_token: %s\n" % e)

Parameters

Name	Type	Description	Notes
child_identifier	str	Either auth key or id of reseller's child

Return type

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]

remove_credits

RemainingCreditModel remove_credits(child_identifier, remove_credits)

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

Example

from __future__ import print_function
import time
import brevo_python
from brevo_python.rest import ApiException
from pprint import pprint

# Configure API key authorization: api-key
configuration = brevo_python.Configuration()
configuration.api_key['api-key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['api-key'] = 'Bearer'
# Configure API key authorization: partner-key
configuration = brevo_python.Configuration()
configuration.api_key['partner-key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['partner-key'] = 'Bearer'

# create an instance of the API class
api_instance = brevo_python.ResellerApi(brevo_python.ApiClient(configuration))
child_identifier = 'child_identifier_example' # str | Either auth key or id of reseller's child
remove_credits = brevo_python.RemoveCredits() # RemoveCredits | Values to post to remove email or SMS credits from a specific child account

try:
    # Remove Email and/or SMS credits from a specific child account
    api_response = api_instance.remove_credits(child_identifier, remove_credits)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ResellerApi->remove_credits: %s\n" % e)

Parameters

Name	Type	Description	Notes
child_identifier	str	Either auth key or id of reseller's child
remove_credits	RemoveCredits	Values to post to remove email or SMS credits from a specific child account

Return type

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]

update_child_account_status

update_child_account_status(child_identifier, update_child_account_status)

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

Example

from __future__ import print_function
import time
import brevo_python
from brevo_python.rest import ApiException
from pprint import pprint

# Configure API key authorization: api-key
configuration = brevo_python.Configuration()
configuration.api_key['api-key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['api-key'] = 'Bearer'
# Configure API key authorization: partner-key
configuration = brevo_python.Configuration()
configuration.api_key['partner-key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['partner-key'] = 'Bearer'

# create an instance of the API class
api_instance = brevo_python.ResellerApi(brevo_python.ApiClient(configuration))
child_identifier = 'child_identifier_example' # str | Either auth key or id of reseller's child
update_child_account_status = brevo_python.UpdateChildAccountStatus() # UpdateChildAccountStatus | values to update in child account status

try:
    # Update info of reseller's child account status based on the childIdentifier supplied
    api_instance.update_child_account_status(child_identifier, update_child_account_status)
except ApiException as e:
    print("Exception when calling ResellerApi->update_child_account_status: %s\n" % e)

Parameters

Name	Type	Description	Notes
child_identifier	str	Either auth key or id of reseller's child
update_child_account_status	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]

update_child_domain

update_child_domain(child_identifier, domain_name, update_child_domain)

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

Example

from __future__ import print_function
import time
import brevo_python
from brevo_python.rest import ApiException
from pprint import pprint

# Configure API key authorization: api-key
configuration = brevo_python.Configuration()
configuration.api_key['api-key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['api-key'] = 'Bearer'
# Configure API key authorization: partner-key
configuration = brevo_python.Configuration()
configuration.api_key['partner-key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['partner-key'] = 'Bearer'

# create an instance of the API class
api_instance = brevo_python.ResellerApi(brevo_python.ApiClient(configuration))
child_identifier = 'child_identifier_example' # str | Either auth key or id of reseller's child
domain_name = 'domain_name_example' # str | Pass the existing domain that needs to be updated
update_child_domain = brevo_python.UpdateChildDomain() # UpdateChildDomain | value to update for sender domain

try:
    # Update the sender domain of reseller's child based on the childIdentifier and domainName passed
    api_instance.update_child_domain(child_identifier, domain_name, update_child_domain)
except ApiException as e:
    print("Exception when calling ResellerApi->update_child_domain: %s\n" % e)

Parameters

Name	Type	Description
child_identifier	str	Either auth key or id of reseller's child
domain_name	str	Pass the existing domain that needs to be updated
update_child_domain	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]

update_reseller_child

update_reseller_child(child_identifier, reseller_child)

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

Example

from __future__ import print_function
import time
import brevo_python
from brevo_python.rest import ApiException
from pprint import pprint

# Configure API key authorization: api-key
configuration = brevo_python.Configuration()
configuration.api_key['api-key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['api-key'] = 'Bearer'
# Configure API key authorization: partner-key
configuration = brevo_python.Configuration()
configuration.api_key['partner-key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['partner-key'] = 'Bearer'

# create an instance of the API class
api_instance = brevo_python.ResellerApi(brevo_python.ApiClient(configuration))
child_identifier = 'child_identifier_example' # str | Either auth key or id of reseller's child
reseller_child = brevo_python.UpdateChild() # UpdateChild | values to update in child profile

try:
    # Update info of reseller's child based on the child identifier supplied
    api_instance.update_reseller_child(child_identifier, reseller_child)
except ApiException as e:
    print("Exception when calling ResellerApi->update_reseller_child: %s\n" % e)

Parameters

Name	Type	Description	Notes
child_identifier	str	Either auth key or id of reseller's child
reseller_child	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_python.ResellerApi

add_credits

Example

Parameters

Return type

Authorization

HTTP request headers

associate_ip_to_child

Example

Parameters

Return type

Authorization

HTTP request headers

create_child_domain

Example

Parameters

Return type

Authorization

HTTP request headers

create_reseller_child

Example

Parameters

Return type

Authorization

HTTP request headers

delete_child_domain

Example

Parameters

Return type

Authorization

HTTP request headers

delete_reseller_child

Example

Parameters

Return type

Authorization

HTTP request headers

dissociate_ip_from_child

Example

Parameters

Return type

Authorization

HTTP request headers

get_child_account_creation_status

Example

Parameters

Return type

Authorization

HTTP request headers

get_child_domains

Example

Parameters

Return type

Authorization

HTTP request headers

get_child_info

Example

Parameters

Return type

Authorization

HTTP request headers

get_reseller_childs

Example

Parameters

Return type

Authorization

HTTP request headers

get_sso_token

Example

Parameters

Return type

Authorization

HTTP request headers

remove_credits