Skip to content

Latest commit

 

History

History
984 lines (739 loc) · 34.6 KB

ResellerApi.md

File metadata and controls

984 lines (739 loc) · 34.6 KB

ResellerApi

All URIs are relative to https://api.sendinblue.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 Sendinblue (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

RemainingCreditModel addCredits(childIdentifier, addCredits)

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

Example

// Import classes:
//import sendinblue.ApiClient;
//import sendinblue.ApiException;
//import sendinblue.Configuration;
//import sendinblue.auth.*;
//import sibApi.ResellerApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure API key authorization: api-key
ApiKeyAuth apiKey = (ApiKeyAuth) defaultClient.getAuthentication("api-key");
apiKey.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//apiKey.setApiKeyPrefix("Token");

// Configure API key authorization: partner-key
ApiKeyAuth partnerKey = (ApiKeyAuth) defaultClient.getAuthentication("partner-key");
partnerKey.setApiKey("YOUR PARTNER KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//partnerKey.setApiKeyPrefix("Token");

ResellerApi apiInstance = new ResellerApi();
String childIdentifier = "childIdentifier_example"; // String | Either auth key or id of reseller's child
AddCredits addCredits = new AddCredits(); // AddCredits | Values to post to add credit to a specific child account
try {
    RemainingCreditModel result = apiInstance.addCredits(childIdentifier, addCredits);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling ResellerApi#addCredits");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
childIdentifier String Either auth key or id of reseller's child
addCredits 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

associateIpToChild

associateIpToChild(childIdentifier, ip)

Associate a dedicated IP to the child

Example

// Import classes:
//import sendinblue.ApiClient;
//import sendinblue.ApiException;
//import sendinblue.Configuration;
//import sendinblue.auth.*;
//import sibApi.ResellerApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure API key authorization: api-key
ApiKeyAuth apiKey = (ApiKeyAuth) defaultClient.getAuthentication("api-key");
apiKey.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//apiKey.setApiKeyPrefix("Token");

// Configure API key authorization: partner-key
ApiKeyAuth partnerKey = (ApiKeyAuth) defaultClient.getAuthentication("partner-key");
partnerKey.setApiKey("YOUR PARTNER KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//partnerKey.setApiKeyPrefix("Token");

ResellerApi apiInstance = new ResellerApi();
String childIdentifier = "childIdentifier_example"; // String | Either auth key or id of reseller's child
ManageIp ip = new ManageIp(); // ManageIp | IP to associate
try {
    apiInstance.associateIpToChild(childIdentifier, ip);
} catch (ApiException e) {
    System.err.println("Exception when calling ResellerApi#associateIpToChild");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
childIdentifier String Either auth key or id of reseller's child
ip ManageIp IP to associate

Return type

null (empty response body)

Authorization

api-key, partner-key

HTTP request headers

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

createChildDomain

createChildDomain(childIdentifier, addChildDomain)

Create a domain for a child account

Example

// Import classes:
//import sendinblue.ApiClient;
//import sendinblue.ApiException;
//import sendinblue.Configuration;
//import sendinblue.auth.*;
//import sibApi.ResellerApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure API key authorization: api-key
ApiKeyAuth apiKey = (ApiKeyAuth) defaultClient.getAuthentication("api-key");
apiKey.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//apiKey.setApiKeyPrefix("Token");

// Configure API key authorization: partner-key
ApiKeyAuth partnerKey = (ApiKeyAuth) defaultClient.getAuthentication("partner-key");
partnerKey.setApiKey("YOUR PARTNER KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//partnerKey.setApiKeyPrefix("Token");

ResellerApi apiInstance = new ResellerApi();
String childIdentifier = "childIdentifier_example"; // String | Either auth key or id of reseller's child
AddChildDomain addChildDomain = new AddChildDomain(); // 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 (ApiException e) {
    System.err.println("Exception when calling ResellerApi#createChildDomain");
    e.printStackTrace();
}

Parameters

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

Return type

null (empty response body)

Authorization

api-key, partner-key

HTTP request headers

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

createResellerChild

CreateReseller createResellerChild(resellerChild)

Creates a reseller child

Example

// Import classes:
//import sendinblue.ApiClient;
//import sendinblue.ApiException;
//import sendinblue.Configuration;
//import sendinblue.auth.*;
//import sibApi.ResellerApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure API key authorization: api-key
ApiKeyAuth apiKey = (ApiKeyAuth) defaultClient.getAuthentication("api-key");
apiKey.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//apiKey.setApiKeyPrefix("Token");

// Configure API key authorization: partner-key
ApiKeyAuth partnerKey = (ApiKeyAuth) defaultClient.getAuthentication("partner-key");
partnerKey.setApiKey("YOUR PARTNER KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//partnerKey.setApiKeyPrefix("Token");

ResellerApi apiInstance = new ResellerApi();
CreateChild resellerChild = new CreateChild(); // CreateChild | reseller child to add
try {
    CreateReseller result = apiInstance.createResellerChild(resellerChild);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling ResellerApi#createResellerChild");
    e.printStackTrace();
}

Parameters

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

Return type

CreateReseller

Authorization

api-key, partner-key

HTTP request headers

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

deleteChildDomain

deleteChildDomain(childIdentifier, domainName)

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

Example

// Import classes:
//import sendinblue.ApiClient;
//import sendinblue.ApiException;
//import sendinblue.Configuration;
//import sendinblue.auth.*;
//import sibApi.ResellerApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure API key authorization: api-key
ApiKeyAuth apiKey = (ApiKeyAuth) defaultClient.getAuthentication("api-key");
apiKey.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//apiKey.setApiKeyPrefix("Token");

// Configure API key authorization: partner-key
ApiKeyAuth partnerKey = (ApiKeyAuth) defaultClient.getAuthentication("partner-key");
partnerKey.setApiKey("YOUR PARTNER KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//partnerKey.setApiKeyPrefix("Token");

ResellerApi apiInstance = new ResellerApi();
String childIdentifier = "childIdentifier_example"; // String | Either auth key or id of reseller's child
String domainName = "domainName_example"; // String | Pass the existing domain that needs to be deleted
try {
    apiInstance.deleteChildDomain(childIdentifier, domainName);
} catch (ApiException e) {
    System.err.println("Exception when calling ResellerApi#deleteChildDomain");
    e.printStackTrace();
}

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

null (empty response body)

Authorization

api-key, partner-key

HTTP request headers

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

deleteResellerChild

deleteResellerChild(childIdentifier)

Delete a single reseller child based on the child identifier supplied

Example

// Import classes:
//import sendinblue.ApiClient;
//import sendinblue.ApiException;
//import sendinblue.Configuration;
//import sendinblue.auth.*;
//import sibApi.ResellerApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure API key authorization: api-key
ApiKeyAuth apiKey = (ApiKeyAuth) defaultClient.getAuthentication("api-key");
apiKey.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//apiKey.setApiKeyPrefix("Token");

// Configure API key authorization: partner-key
ApiKeyAuth partnerKey = (ApiKeyAuth) defaultClient.getAuthentication("partner-key");
partnerKey.setApiKey("YOUR PARTNER KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//partnerKey.setApiKeyPrefix("Token");

ResellerApi apiInstance = new ResellerApi();
String childIdentifier = "childIdentifier_example"; // String | Either auth key or child id of reseller's child
try {
    apiInstance.deleteResellerChild(childIdentifier);
} catch (ApiException e) {
    System.err.println("Exception when calling ResellerApi#deleteResellerChild");
    e.printStackTrace();
}

Parameters

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

Return type

null (empty response body)

Authorization

api-key, partner-key

HTTP request headers

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

dissociateIpFromChild

dissociateIpFromChild(childIdentifier, ip)

Dissociate a dedicated IP to the child

Example

// Import classes:
//import sendinblue.ApiClient;
//import sendinblue.ApiException;
//import sendinblue.Configuration;
//import sendinblue.auth.*;
//import sibApi.ResellerApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure API key authorization: api-key
ApiKeyAuth apiKey = (ApiKeyAuth) defaultClient.getAuthentication("api-key");
apiKey.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//apiKey.setApiKeyPrefix("Token");

// Configure API key authorization: partner-key
ApiKeyAuth partnerKey = (ApiKeyAuth) defaultClient.getAuthentication("partner-key");
partnerKey.setApiKey("YOUR PARTNER KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//partnerKey.setApiKeyPrefix("Token");

ResellerApi apiInstance = new ResellerApi();
String childIdentifier = "childIdentifier_example"; // String | Either auth key or id of reseller's child
ManageIp ip = new ManageIp(); // ManageIp | IP to dissociate
try {
    apiInstance.dissociateIpFromChild(childIdentifier, ip);
} catch (ApiException e) {
    System.err.println("Exception when calling ResellerApi#dissociateIpFromChild");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
childIdentifier String Either auth key or id of reseller's child
ip ManageIp IP to dissociate

Return type

null (empty response body)

Authorization

api-key, partner-key

HTTP request headers

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

getChildAccountCreationStatus

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

// Import classes:
//import sendinblue.ApiClient;
//import sendinblue.ApiException;
//import sendinblue.Configuration;
//import sendinblue.auth.*;
//import sibApi.ResellerApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure API key authorization: api-key
ApiKeyAuth apiKey = (ApiKeyAuth) defaultClient.getAuthentication("api-key");
apiKey.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//apiKey.setApiKeyPrefix("Token");

// Configure API key authorization: partner-key
ApiKeyAuth partnerKey = (ApiKeyAuth) defaultClient.getAuthentication("partner-key");
partnerKey.setApiKey("YOUR PARTNER KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//partnerKey.setApiKeyPrefix("Token");

ResellerApi apiInstance = new ResellerApi();
String childIdentifier = "childIdentifier_example"; // String | Either auth key or id of reseller's child
try {
    GetChildAccountCreationStatus result = apiInstance.getChildAccountCreationStatus(childIdentifier);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling ResellerApi#getChildAccountCreationStatus");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
childIdentifier String 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

getChildDomains

GetChildDomains getChildDomains(childIdentifier)

Get all sender domains for a specific child account

Example

// Import classes:
//import sendinblue.ApiClient;
//import sendinblue.ApiException;
//import sendinblue.Configuration;
//import sendinblue.auth.*;
//import sibApi.ResellerApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure API key authorization: api-key
ApiKeyAuth apiKey = (ApiKeyAuth) defaultClient.getAuthentication("api-key");
apiKey.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//apiKey.setApiKeyPrefix("Token");

// Configure API key authorization: partner-key
ApiKeyAuth partnerKey = (ApiKeyAuth) defaultClient.getAuthentication("partner-key");
partnerKey.setApiKey("YOUR PARTNER KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//partnerKey.setApiKeyPrefix("Token");

ResellerApi apiInstance = new ResellerApi();
String childIdentifier = "childIdentifier_example"; // String | Either auth key or id of reseller's child
try {
    GetChildDomains result = apiInstance.getChildDomains(childIdentifier);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling ResellerApi#getChildDomains");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
childIdentifier String 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

getChildInfo

GetChildInfo getChildInfo(childIdentifier)

Get a child account's details

Example

// Import classes:
//import sendinblue.ApiClient;
//import sendinblue.ApiException;
//import sendinblue.Configuration;
//import sendinblue.auth.*;
//import sibApi.ResellerApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure API key authorization: api-key
ApiKeyAuth apiKey = (ApiKeyAuth) defaultClient.getAuthentication("api-key");
apiKey.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//apiKey.setApiKeyPrefix("Token");

// Configure API key authorization: partner-key
ApiKeyAuth partnerKey = (ApiKeyAuth) defaultClient.getAuthentication("partner-key");
partnerKey.setApiKey("YOUR PARTNER KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//partnerKey.setApiKeyPrefix("Token");

ResellerApi apiInstance = new ResellerApi();
String childIdentifier = "childIdentifier_example"; // String | Either auth key or id of reseller's child
try {
    GetChildInfo result = apiInstance.getChildInfo(childIdentifier);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling ResellerApi#getChildInfo");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
childIdentifier String 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

getResellerChilds

GetChildrenList getResellerChilds(limit, offset)

Get the list of all children accounts

Example

// Import classes:
//import sendinblue.ApiClient;
//import sendinblue.ApiException;
//import sendinblue.Configuration;
//import sendinblue.auth.*;
//import sibApi.ResellerApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure API key authorization: api-key
ApiKeyAuth apiKey = (ApiKeyAuth) defaultClient.getAuthentication("api-key");
apiKey.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//apiKey.setApiKeyPrefix("Token");

// Configure API key authorization: partner-key
ApiKeyAuth partnerKey = (ApiKeyAuth) defaultClient.getAuthentication("partner-key");
partnerKey.setApiKey("YOUR PARTNER KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//partnerKey.setApiKeyPrefix("Token");

ResellerApi apiInstance = new ResellerApi();
Long limit = 10L; // Long | Number of documents for child accounts information per page
Long offset = 0L; // Long | Index of the first document in the page
try {
    GetChildrenList result = apiInstance.getResellerChilds(limit, offset);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling ResellerApi#getResellerChilds");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
limit Long Number of documents for child accounts information per page [optional] [default to 10]
offset Long 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

getSsoToken

GetSsoToken getSsoToken(childIdentifier)

Get session token to access Sendinblue (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

// Import classes:
//import sendinblue.ApiClient;
//import sendinblue.ApiException;
//import sendinblue.Configuration;
//import sendinblue.auth.*;
//import sibApi.ResellerApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure API key authorization: api-key
ApiKeyAuth apiKey = (ApiKeyAuth) defaultClient.getAuthentication("api-key");
apiKey.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//apiKey.setApiKeyPrefix("Token");

// Configure API key authorization: partner-key
ApiKeyAuth partnerKey = (ApiKeyAuth) defaultClient.getAuthentication("partner-key");
partnerKey.setApiKey("YOUR PARTNER KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//partnerKey.setApiKeyPrefix("Token");

ResellerApi apiInstance = new ResellerApi();
String childIdentifier = "childIdentifier_example"; // String | Either auth key or id of reseller's child
try {
    GetSsoToken result = apiInstance.getSsoToken(childIdentifier);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling ResellerApi#getSsoToken");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
childIdentifier String 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

removeCredits

RemainingCreditModel removeCredits(childIdentifier, removeCredits)

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

Example

// Import classes:
//import sendinblue.ApiClient;
//import sendinblue.ApiException;
//import sendinblue.Configuration;
//import sendinblue.auth.*;
//import sibApi.ResellerApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure API key authorization: api-key
ApiKeyAuth apiKey = (ApiKeyAuth) defaultClient.getAuthentication("api-key");
apiKey.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//apiKey.setApiKeyPrefix("Token");

// Configure API key authorization: partner-key
ApiKeyAuth partnerKey = (ApiKeyAuth) defaultClient.getAuthentication("partner-key");
partnerKey.setApiKey("YOUR PARTNER KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//partnerKey.setApiKeyPrefix("Token");

ResellerApi apiInstance = new ResellerApi();
String childIdentifier = "childIdentifier_example"; // String | Either auth key or id of reseller's child
RemoveCredits removeCredits = new RemoveCredits(); // RemoveCredits | Values to post to remove email or SMS credits from a specific child account
try {
    RemainingCreditModel result = apiInstance.removeCredits(childIdentifier, removeCredits);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling ResellerApi#removeCredits");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
childIdentifier String Either auth key or id of reseller's child
removeCredits 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

updateChildAccountStatus

updateChildAccountStatus(childIdentifier, updateChildAccountStatus)

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

Example

// Import classes:
//import sendinblue.ApiClient;
//import sendinblue.ApiException;
//import sendinblue.Configuration;
//import sendinblue.auth.*;
//import sibApi.ResellerApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure API key authorization: api-key
ApiKeyAuth apiKey = (ApiKeyAuth) defaultClient.getAuthentication("api-key");
apiKey.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//apiKey.setApiKeyPrefix("Token");

// Configure API key authorization: partner-key
ApiKeyAuth partnerKey = (ApiKeyAuth) defaultClient.getAuthentication("partner-key");
partnerKey.setApiKey("YOUR PARTNER KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//partnerKey.setApiKeyPrefix("Token");

ResellerApi apiInstance = new ResellerApi();
String childIdentifier = "childIdentifier_example"; // String | Either auth key or id of reseller's child
UpdateChildAccountStatus updateChildAccountStatus = new UpdateChildAccountStatus(); // UpdateChildAccountStatus | values to update in child account status
try {
    apiInstance.updateChildAccountStatus(childIdentifier, updateChildAccountStatus);
} catch (ApiException e) {
    System.err.println("Exception when calling ResellerApi#updateChildAccountStatus");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
childIdentifier String Either auth key or id of reseller's child
updateChildAccountStatus UpdateChildAccountStatus values to update in child account status

Return type

null (empty response body)

Authorization

api-key, partner-key

HTTP request headers

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

updateChildDomain

updateChildDomain(childIdentifier, domainName, updateChildDomain)

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

Example

// Import classes:
//import sendinblue.ApiClient;
//import sendinblue.ApiException;
//import sendinblue.Configuration;
//import sendinblue.auth.*;
//import sibApi.ResellerApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure API key authorization: api-key
ApiKeyAuth apiKey = (ApiKeyAuth) defaultClient.getAuthentication("api-key");
apiKey.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//apiKey.setApiKeyPrefix("Token");

// Configure API key authorization: partner-key
ApiKeyAuth partnerKey = (ApiKeyAuth) defaultClient.getAuthentication("partner-key");
partnerKey.setApiKey("YOUR PARTNER KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//partnerKey.setApiKeyPrefix("Token");

ResellerApi apiInstance = new ResellerApi();
String childIdentifier = "childIdentifier_example"; // String | Either auth key or id of reseller's child
String domainName = "domainName_example"; // String | Pass the existing domain that needs to be updated
UpdateChildDomain updateChildDomain = new UpdateChildDomain(); // UpdateChildDomain | value to update for sender domain
try {
    apiInstance.updateChildDomain(childIdentifier, domainName, updateChildDomain);
} catch (ApiException e) {
    System.err.println("Exception when calling ResellerApi#updateChildDomain");
    e.printStackTrace();
}

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 updated
updateChildDomain UpdateChildDomain value to update for sender domain

Return type

null (empty response body)

Authorization

api-key, partner-key

HTTP request headers

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

updateResellerChild

updateResellerChild(childIdentifier, resellerChild)

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

Example

// Import classes:
//import sendinblue.ApiClient;
//import sendinblue.ApiException;
//import sendinblue.Configuration;
//import sendinblue.auth.*;
//import sibApi.ResellerApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure API key authorization: api-key
ApiKeyAuth apiKey = (ApiKeyAuth) defaultClient.getAuthentication("api-key");
apiKey.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//apiKey.setApiKeyPrefix("Token");

// Configure API key authorization: partner-key
ApiKeyAuth partnerKey = (ApiKeyAuth) defaultClient.getAuthentication("partner-key");
partnerKey.setApiKey("YOUR PARTNER KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//partnerKey.setApiKeyPrefix("Token");

ResellerApi apiInstance = new ResellerApi();
String childIdentifier = "childIdentifier_example"; // String | Either auth key or id of reseller's child
UpdateChild resellerChild = new UpdateChild(); // UpdateChild | values to update in child profile
try {
    apiInstance.updateResellerChild(childIdentifier, resellerChild);
} catch (ApiException e) {
    System.err.println("Exception when calling ResellerApi#updateResellerChild");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
childIdentifier String Either auth key or id of reseller's child
resellerChild UpdateChild values to update in child profile

Return type

null (empty response body)

Authorization

api-key, partner-key

HTTP request headers

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