Skip to content

Latest commit

 

History

History
1128 lines (883 loc) · 40.6 KB

ResellerApi.md

File metadata and controls

1128 lines (883 loc) · 40.6 KB

sib_api_v3_sdk.Api.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 (string childIdentifier, AddCredits addCredits)

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

Example

using System;
using System.Diagnostics;
using sib_api_v3_sdk.Api;
using sib_api_v3_sdk.Client;
using sib_api_v3_sdk.Model;

namespace Example
{
    public class AddCreditsExample
    {
        public void main()
        {
            // Configure API key authorization: api-key
            Configuration.Default.AddApiKey("api-key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.AddApiKeyPrefix("api-key", "Bearer");
            // Configure API key authorization: partner-key
            Configuration.Default.AddApiKey("partner-key", "YOUR_PARTNER_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.AddApiKeyPrefix("partner-key", "Bearer");

            var apiInstance = new ResellerApi();
            var childIdentifier = childIdentifier_example;  // string | Either auth key or id of reseller's child
            var addCredits = new 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
                RemainingCreditModel result = apiInstance.AddCredits(childIdentifier, addCredits);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ResellerApi.AddCredits: " + e.Message );
            }
        }
    }
}

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

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

AssociateIpToChild

void AssociateIpToChild (string childIdentifier, ManageIp ip)

Associate a dedicated IP to the child

Example

using System;
using System.Diagnostics;
using sib_api_v3_sdk.Api;
using sib_api_v3_sdk.Client;
using sib_api_v3_sdk.Model;

namespace Example
{
    public class AssociateIpToChildExample
    {
        public void main()
        {
            // Configure API key authorization: api-key
            Configuration.Default.AddApiKey("api-key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.AddApiKeyPrefix("api-key", "Bearer");
            // Configure API key authorization: partner-key
            Configuration.Default.AddApiKey("partner-key", "YOUR_PARTNER_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.AddApiKeyPrefix("partner-key", "Bearer");

            var apiInstance = new ResellerApi();
            var childIdentifier = childIdentifier_example;  // string | Either auth key or id of reseller's child
            var ip = new ManageIp(); // ManageIp | IP to associate

            try
            {
                // Associate a dedicated IP to the child
                apiInstance.AssociateIpToChild(childIdentifier, ip);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ResellerApi.AssociateIpToChild: " + e.Message );
            }
        }
    }
}

Parameters

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

CreateChildDomain

void CreateChildDomain (string childIdentifier, AddChildDomain addChildDomain)

Create a domain for a child account

Example

using System;
using System.Diagnostics;
using sib_api_v3_sdk.Api;
using sib_api_v3_sdk.Client;
using sib_api_v3_sdk.Model;

namespace Example
{
    public class CreateChildDomainExample
    {
        public void main()
        {
            // Configure API key authorization: api-key
            Configuration.Default.AddApiKey("api-key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.AddApiKeyPrefix("api-key", "Bearer");
            // Configure API key authorization: partner-key
            Configuration.Default.AddApiKey("partner-key", "YOUR_PARTNER_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.AddApiKeyPrefix("partner-key", "Bearer");

            var apiInstance = new ResellerApi();
            var childIdentifier = childIdentifier_example;  // string | Either auth key or id of reseller's child
            var addChildDomain = new 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
                apiInstance.CreateChildDomain(childIdentifier, addChildDomain);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ResellerApi.CreateChildDomain: " + e.Message );
            }
        }
    }
}

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

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

CreateReseller CreateResellerChild (CreateChild resellerChild = null)

Creates a reseller child

Example

using System;
using System.Diagnostics;
using sib_api_v3_sdk.Api;
using sib_api_v3_sdk.Client;
using sib_api_v3_sdk.Model;

namespace Example
{
    public class CreateResellerChildExample
    {
        public void main()
        {
            // Configure API key authorization: api-key
            Configuration.Default.AddApiKey("api-key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.AddApiKeyPrefix("api-key", "Bearer");
            // Configure API key authorization: partner-key
            Configuration.Default.AddApiKey("partner-key", "YOUR_PARTNER_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.AddApiKeyPrefix("partner-key", "Bearer");

            var apiInstance = new ResellerApi();
            var resellerChild = new CreateChild(); // CreateChild | reseller child to add (optional) 

            try
            {
                // Creates a reseller child
                CreateReseller result = apiInstance.CreateResellerChild(resellerChild);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ResellerApi.CreateResellerChild: " + e.Message );
            }
        }
    }
}

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

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

DeleteChildDomain

void DeleteChildDomain (string childIdentifier, string domainName)

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

Example

using System;
using System.Diagnostics;
using sib_api_v3_sdk.Api;
using sib_api_v3_sdk.Client;
using sib_api_v3_sdk.Model;

namespace Example
{
    public class DeleteChildDomainExample
    {
        public void main()
        {
            // Configure API key authorization: api-key
            Configuration.Default.AddApiKey("api-key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.AddApiKeyPrefix("api-key", "Bearer");
            // Configure API key authorization: partner-key
            Configuration.Default.AddApiKey("partner-key", "YOUR_PARTNER_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.AddApiKeyPrefix("partner-key", "Bearer");

            var apiInstance = new ResellerApi();
            var childIdentifier = childIdentifier_example;  // string | Either auth key or id of reseller's child
            var domainName = domainName_example;  // string | 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
                apiInstance.DeleteChildDomain(childIdentifier, domainName);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ResellerApi.DeleteChildDomain: " + e.Message );
            }
        }
    }
}

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

void DeleteResellerChild (string childIdentifier)

Delete a single reseller child based on the child identifier supplied

Example

using System;
using System.Diagnostics;
using sib_api_v3_sdk.Api;
using sib_api_v3_sdk.Client;
using sib_api_v3_sdk.Model;

namespace Example
{
    public class DeleteResellerChildExample
    {
        public void main()
        {
            // Configure API key authorization: api-key
            Configuration.Default.AddApiKey("api-key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.AddApiKeyPrefix("api-key", "Bearer");
            // Configure API key authorization: partner-key
            Configuration.Default.AddApiKey("partner-key", "YOUR_PARTNER_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.AddApiKeyPrefix("partner-key", "Bearer");

            var apiInstance = new ResellerApi();
            var childIdentifier = childIdentifier_example;  // string | Either auth key or child id of reseller's child

            try
            {
                // Delete a single reseller child based on the child identifier supplied
                apiInstance.DeleteResellerChild(childIdentifier);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ResellerApi.DeleteResellerChild: " + e.Message );
            }
        }
    }
}

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

void DissociateIpFromChild (string childIdentifier, ManageIp ip)

Dissociate a dedicated IP to the child

Example

using System;
using System.Diagnostics;
using sib_api_v3_sdk.Api;
using sib_api_v3_sdk.Client;
using sib_api_v3_sdk.Model;

namespace Example
{
    public class DissociateIpFromChildExample
    {
        public void main()
        {
            // Configure API key authorization: api-key
            Configuration.Default.AddApiKey("api-key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.AddApiKeyPrefix("api-key", "Bearer");
            // Configure API key authorization: partner-key
            Configuration.Default.AddApiKey("partner-key", "YOUR_PARTNER_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.AddApiKeyPrefix("partner-key", "Bearer");

            var apiInstance = new ResellerApi();
            var childIdentifier = childIdentifier_example;  // string | Either auth key or id of reseller's child
            var ip = new ManageIp(); // ManageIp | IP to dissociate

            try
            {
                // Dissociate a dedicated IP to the child
                apiInstance.DissociateIpFromChild(childIdentifier, ip);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ResellerApi.DissociateIpFromChild: " + e.Message );
            }
        }
    }
}

Parameters

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

GetChildAccountCreationStatus

GetChildAccountCreationStatus GetChildAccountCreationStatus (string 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

using System;
using System.Diagnostics;
using sib_api_v3_sdk.Api;
using sib_api_v3_sdk.Client;
using sib_api_v3_sdk.Model;

namespace Example
{
    public class GetChildAccountCreationStatusExample
    {
        public void main()
        {
            // Configure API key authorization: api-key
            Configuration.Default.AddApiKey("api-key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.AddApiKeyPrefix("api-key", "Bearer");
            // Configure API key authorization: partner-key
            Configuration.Default.AddApiKey("partner-key", "YOUR_PARTNER_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.AddApiKeyPrefix("partner-key", "Bearer");

            var apiInstance = new ResellerApi();
            var childIdentifier = childIdentifier_example;  // string | 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
                GetChildAccountCreationStatus result = apiInstance.GetChildAccountCreationStatus(childIdentifier);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ResellerApi.GetChildAccountCreationStatus: " + e.Message );
            }
        }
    }
}

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

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

GetChildDomains

GetChildDomains GetChildDomains (string childIdentifier)

Get all sender domains for a specific child account

Example

using System;
using System.Diagnostics;
using sib_api_v3_sdk.Api;
using sib_api_v3_sdk.Client;
using sib_api_v3_sdk.Model;

namespace Example
{
    public class GetChildDomainsExample
    {
        public void main()
        {
            // Configure API key authorization: api-key
            Configuration.Default.AddApiKey("api-key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.AddApiKeyPrefix("api-key", "Bearer");
            // Configure API key authorization: partner-key
            Configuration.Default.AddApiKey("partner-key", "YOUR_PARTNER_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.AddApiKeyPrefix("partner-key", "Bearer");

            var apiInstance = new ResellerApi();
            var childIdentifier = childIdentifier_example;  // string | Either auth key or id of reseller's child

            try
            {
                // Get all sender domains for a specific child account
                GetChildDomains result = apiInstance.GetChildDomains(childIdentifier);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ResellerApi.GetChildDomains: " + e.Message );
            }
        }
    }
}

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

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

GetChildInfo

GetChildInfo GetChildInfo (string childIdentifier)

Get a child account's details

Example

using System;
using System.Diagnostics;
using sib_api_v3_sdk.Api;
using sib_api_v3_sdk.Client;
using sib_api_v3_sdk.Model;

namespace Example
{
    public class GetChildInfoExample
    {
        public void main()
        {
            // Configure API key authorization: api-key
            Configuration.Default.AddApiKey("api-key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.AddApiKeyPrefix("api-key", "Bearer");
            // Configure API key authorization: partner-key
            Configuration.Default.AddApiKey("partner-key", "YOUR_PARTNER_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.AddApiKeyPrefix("partner-key", "Bearer");

            var apiInstance = new ResellerApi();
            var childIdentifier = childIdentifier_example;  // string | Either auth key or id of reseller's child

            try
            {
                // Get a child account's details
                GetChildInfo result = apiInstance.GetChildInfo(childIdentifier);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ResellerApi.GetChildInfo: " + e.Message );
            }
        }
    }
}

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

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

GetResellerChilds

GetChildrenList GetResellerChilds (long? limit = null, long? offset = null)

Get the list of all children accounts

Example

using System;
using System.Diagnostics;
using sib_api_v3_sdk.Api;
using sib_api_v3_sdk.Client;
using sib_api_v3_sdk.Model;

namespace Example
{
    public class GetResellerChildsExample
    {
        public void main()
        {
            // Configure API key authorization: api-key
            Configuration.Default.AddApiKey("api-key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.AddApiKeyPrefix("api-key", "Bearer");
            // Configure API key authorization: partner-key
            Configuration.Default.AddApiKey("partner-key", "YOUR_PARTNER_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.AddApiKeyPrefix("partner-key", "Bearer");

            var apiInstance = new ResellerApi();
            var limit = 789;  // long? | Number of documents for child accounts information per page (optional)  (default to 10)
            var offset = 789;  // long? | Index of the first document in the page (optional)  (default to 0)

            try
            {
                // Get the list of all children accounts
                GetChildrenList result = apiInstance.GetResellerChilds(limit, offset);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ResellerApi.GetResellerChilds: " + e.Message );
            }
        }
    }
}

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

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

GetSsoToken

GetSsoToken GetSsoToken (string 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

using System;
using System.Diagnostics;
using sib_api_v3_sdk.Api;
using sib_api_v3_sdk.Client;
using sib_api_v3_sdk.Model;

namespace Example
{
    public class GetSsoTokenExample
    {
        public void main()
        {
            // Configure API key authorization: api-key
            Configuration.Default.AddApiKey("api-key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.AddApiKeyPrefix("api-key", "Bearer");
            // Configure API key authorization: partner-key
            Configuration.Default.AddApiKey("partner-key", "YOUR_PARTNER_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.AddApiKeyPrefix("partner-key", "Bearer");

            var apiInstance = new ResellerApi();
            var childIdentifier = childIdentifier_example;  // string | Either auth key or id of reseller's child

            try
            {
                // Get session token to access Sendinblue (SSO)
                GetSsoToken result = apiInstance.GetSsoToken(childIdentifier);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ResellerApi.GetSsoToken: " + e.Message );
            }
        }
    }
}

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

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

RemoveCredits

RemainingCreditModel RemoveCredits (string childIdentifier, RemoveCredits removeCredits)

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

Example

using System;
using System.Diagnostics;
using sib_api_v3_sdk.Api;
using sib_api_v3_sdk.Client;
using sib_api_v3_sdk.Model;

namespace Example
{
    public class RemoveCreditsExample
    {
        public void main()
        {
            // Configure API key authorization: api-key
            Configuration.Default.AddApiKey("api-key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.AddApiKeyPrefix("api-key", "Bearer");
            // Configure API key authorization: partner-key
            Configuration.Default.AddApiKey("partner-key", "YOUR_PARTNER_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.AddApiKeyPrefix("partner-key", "Bearer");

            var apiInstance = new ResellerApi();
            var childIdentifier = childIdentifier_example;  // string | Either auth key or id of reseller's child
            var removeCredits = new 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
                RemainingCreditModel result = apiInstance.RemoveCredits(childIdentifier, removeCredits);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ResellerApi.RemoveCredits: " + e.Message );
            }
        }
    }
}

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

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

UpdateChildAccountStatus

void UpdateChildAccountStatus (string childIdentifier, UpdateChildAccountStatus updateChildAccountStatus)

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

Example

using System;
using System.Diagnostics;
using sib_api_v3_sdk.Api;
using sib_api_v3_sdk.Client;
using sib_api_v3_sdk.Model;

namespace Example
{
    public class UpdateChildAccountStatusExample
    {
        public void main()
        {
            // Configure API key authorization: api-key
            Configuration.Default.AddApiKey("api-key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.AddApiKeyPrefix("api-key", "Bearer");
            // Configure API key authorization: partner-key
            Configuration.Default.AddApiKey("partner-key", "YOUR_PARTNER_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.AddApiKeyPrefix("partner-key", "Bearer");

            var apiInstance = new ResellerApi();
            var childIdentifier = childIdentifier_example;  // string | Either auth key or id of reseller's child
            var updateChildAccountStatus = new UpdateChildAccountStatus(); // UpdateChildAccountStatus | values to update in child account status

            try
            {
                // Update info of reseller's child account status based on the childIdentifier supplied
                apiInstance.UpdateChildAccountStatus(childIdentifier, updateChildAccountStatus);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ResellerApi.UpdateChildAccountStatus: " + e.Message );
            }
        }
    }
}

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

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

void UpdateChildDomain (string childIdentifier, string domainName, UpdateChildDomain updateChildDomain)

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

Example

using System;
using System.Diagnostics;
using sib_api_v3_sdk.Api;
using sib_api_v3_sdk.Client;
using sib_api_v3_sdk.Model;

namespace Example
{
    public class UpdateChildDomainExample
    {
        public void main()
        {
            // Configure API key authorization: api-key
            Configuration.Default.AddApiKey("api-key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.AddApiKeyPrefix("api-key", "Bearer");
            // Configure API key authorization: partner-key
            Configuration.Default.AddApiKey("partner-key", "YOUR_PARTNER_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.AddApiKeyPrefix("partner-key", "Bearer");

            var apiInstance = new ResellerApi();
            var childIdentifier = childIdentifier_example;  // string | Either auth key or id of reseller's child
            var domainName = domainName_example;  // string | Pass the existing domain that needs to be updated
            var updateChildDomain = new UpdateChildDomain(); // UpdateChildDomain | value to update for sender domain

            try
            {
                // Update the sender domain of reseller's child based on the childIdentifier and domainName passed
                apiInstance.UpdateChildDomain(childIdentifier, domainName, updateChildDomain);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ResellerApi.UpdateChildDomain: " + e.Message );
            }
        }
    }
}

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

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

void UpdateResellerChild (string childIdentifier, UpdateChild resellerChild)

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

Example

using System;
using System.Diagnostics;
using sib_api_v3_sdk.Api;
using sib_api_v3_sdk.Client;
using sib_api_v3_sdk.Model;

namespace Example
{
    public class UpdateResellerChildExample
    {
        public void main()
        {
            // Configure API key authorization: api-key
            Configuration.Default.AddApiKey("api-key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.AddApiKeyPrefix("api-key", "Bearer");
            // Configure API key authorization: partner-key
            Configuration.Default.AddApiKey("partner-key", "YOUR_PARTNER_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.AddApiKeyPrefix("partner-key", "Bearer");

            var apiInstance = new ResellerApi();
            var childIdentifier = childIdentifier_example;  // string | Either auth key or id of reseller's child
            var resellerChild = new UpdateChild(); // UpdateChild | values to update in child profile

            try
            {
                // Update info of reseller's child based on the child identifier supplied
                apiInstance.UpdateResellerChild(childIdentifier, resellerChild);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ResellerApi.UpdateResellerChild: " + e.Message );
            }
        }
    }
}

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

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]