SendersApi

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

Method	HTTP request	Description
createSender	POST /senders	Create a new sender
deleteSender	DELETE /senders/{senderId}	Delete a sender
getIps	GET /senders/ips	Get all the dedicated IPs for your account
getIpsFromSender	GET /senders/{senderId}/ips	Get all the dedicated IPs for a sender
getSenders	GET /senders	Get the list of all your senders
updateSender	PUT /senders/{senderId}	Update a sender

createSender

CreateSenderModel createSender(sender)

Create a new sender

Example

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

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");

SendersApi apiInstance = new SendersApi();
CreateSender sender = new CreateSender(); // CreateSender | sender's name
try {
    CreateSenderModel result = apiInstance.createSender(sender);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling SendersApi#createSender");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
sender	CreateSender	sender's name	[optional]

Return type

CreateSenderModel

Authorization

api-key, partner-key

HTTP request headers

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

deleteSender

deleteSender(senderId)

Delete a sender

Example

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

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");

SendersApi apiInstance = new SendersApi();
Long senderId = 789L; // Long | Id of the sender
try {
    apiInstance.deleteSender(senderId);
} catch (ApiException e) {
    System.err.println("Exception when calling SendersApi#deleteSender");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
senderId	Long	Id of the sender

Return type

null (empty response body)

Authorization

api-key, partner-key

HTTP request headers

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

getIps

GetIps getIps()

Get all the dedicated IPs for your account

Example

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

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");

SendersApi apiInstance = new SendersApi();
try {
    GetIps result = apiInstance.getIps();
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling SendersApi#getIps");
    e.printStackTrace();
}

Parameters

This endpoint does not need any parameter.

Return type

GetIps

Authorization

api-key, partner-key

HTTP request headers

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

getIpsFromSender

GetIpsFromSender getIpsFromSender(senderId)

Get all the dedicated IPs for a sender

Example

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

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");

SendersApi apiInstance = new SendersApi();
Long senderId = 789L; // Long | Id of the sender
try {
    GetIpsFromSender result = apiInstance.getIpsFromSender(senderId);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling SendersApi#getIpsFromSender");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
senderId	Long	Id of the sender

Return type

GetIpsFromSender

Authorization

api-key, partner-key

HTTP request headers

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

getSenders

GetSendersList getSenders(ip, domain)

Get the list of all your senders

Example

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

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");

SendersApi apiInstance = new SendersApi();
String ip = "ip_example"; // String | Filter your senders for a specific ip (available for dedicated IP usage only)
String domain = "domain_example"; // String | Filter your senders for a specific domain
try {
    GetSendersList result = apiInstance.getSenders(ip, domain);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling SendersApi#getSenders");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
ip	String	Filter your senders for a specific ip (available for dedicated IP usage only)	[optional]
domain	String	Filter your senders for a specific domain	[optional]

Return type

GetSendersList

Authorization

api-key, partner-key

HTTP request headers

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

updateSender

updateSender(senderId, sender)

Update a sender

Example

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

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");

SendersApi apiInstance = new SendersApi();
Long senderId = 789L; // Long | Id of the sender
UpdateSender sender = new UpdateSender(); // UpdateSender | sender's name
try {
    apiInstance.updateSender(senderId, sender);
} catch (ApiException e) {
    System.err.println("Exception when calling SendersApi#updateSender");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
senderId	Long	Id of the sender
sender	UpdateSender	sender's name	[optional]

Return type

null (empty response body)

Authorization

api-key, partner-key

HTTP request headers

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

Files

SendersApi.md

Latest commit

History

SendersApi.md

File metadata and controls

SendersApi

createSender

Example

Parameters

Return type

Authorization

HTTP request headers

deleteSender

Example

Parameters

Return type

Authorization

HTTP request headers

getIps

Example

Parameters

Return type

Authorization

HTTP request headers

getIpsFromSender

Example

Parameters

Return type

Authorization

HTTP request headers

getSenders

Example

Parameters

Return type

Authorization

HTTP request headers

updateSender

Example

Parameters

Return type

Authorization

HTTP request headers