Skip to content
SendinBlue's API v3 Java Library
Java Other
  1. Java 99.9%
  2. Other 0.1%
Branch: master
Clone or download
Latest commit f92a642 Aug 27, 2018
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.swagger-codegen Initial release of SendinBlue API V3 Java Package Feb 15, 2018
docs Mixed spec updates Aug 27, 2018
gradle/wrapper
src Mixed spec updates Aug 27, 2018
.gitignore Initial release of SendinBlue API V3 Java Package Feb 15, 2018
.swagger-codegen-ignore Initial release of SendinBlue API V3 Java Package Feb 15, 2018
.travis.yml Mixed spec updates May 28, 2018
LICENSE.md Initial release of SendinBlue API V3 Java Package Feb 15, 2018
README.md Mixed spec updates Aug 27, 2018
build.gradle Mixed spec updates Aug 27, 2018
build.sbt Mixed spec updates Aug 27, 2018
git_push.sh Initial release of SendinBlue API V3 Java Package Feb 15, 2018
gradle.properties Initial release of SendinBlue API V3 Java Package Feb 15, 2018
gradlew Mixed spec updates May 28, 2018
gradlew.bat Initial release of SendinBlue API V3 Java Package Feb 15, 2018
pom.xml Mixed spec updates Aug 27, 2018
settings.gradle Initial release of SendinBlue API V3 Java Package Feb 15, 2018

README.md

SendinBlue's API v3 Java Library

SendinBlue's API exposes the entire SendinBlue features via a standardized programmatic interface. Please refer to the full documentation to learn more.

This is the wrapper for the API. It implements all the features of the API v3.

SendinBlue's API matches the OpenAPI v2 definition. The specification can be downloaded here.

Installation

To install the API client library to your local Maven repository, simply execute:

mvn install

Maven users

Add this dependency to your project's POM:

<dependency>
    <groupId>com.sendinblue</groupId>
    <artifactId>sib-api-v3-sdk</artifactId>
    <version>3.0.1</version>
    <scope>compile</scope>
</dependency>

Gradle users

Add this dependency to your project's build file:

compile "com.sendinblue:sib-api-v3-sdk:3.0.1"

Others

At first generate the JAR by executing:

    mvn package

Then manually install the following JARs:

  • target/sib-api-v3-sdk-3.0.1.jar
  • target/lib/*.jar

Getting Started

Please follow the installation instruction and execute the following Java code:

import sendinblue.*;
import sendinblue.auth.*;
import sibModel.*;
import sibApi.AccountApi;

import java.io.File;
import java.util.*;

public class AccountApiExample {

    public static void main(String[] args) {
        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");

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

Documentation for API Endpoints

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

Class Method HTTP request Description
AccountApi getAccount GET /account Get your account informations, plans and credits details
AttributesApi createAttribute POST /contacts/attributes/{attributeCategory}/{attributeName} Creates contact attribute
AttributesApi deleteAttribute DELETE /contacts/attributes/{attributeCategory}/{attributeName} Deletes an attribute
AttributesApi getAttributes GET /contacts/attributes Lists all attributes
AttributesApi updateAttribute PUT /contacts/attributes/{attributeCategory}/{attributeName} Updates contact attribute
ContactsApi addContactToList POST /contacts/lists/{listId}/contacts/add Add existing contacts to a list
ContactsApi createAttribute POST /contacts/attributes/{attributeCategory}/{attributeName} Creates contact attribute
ContactsApi createContact POST /contacts Create a contact
ContactsApi createFolder POST /contacts/folders Create a folder
ContactsApi createList POST /contacts/lists Create a list
ContactsApi deleteAttribute DELETE /contacts/attributes/{attributeCategory}/{attributeName} Deletes an attribute
ContactsApi deleteContact DELETE /contacts/{email} Deletes a contact
ContactsApi deleteFolder DELETE /contacts/folders/{folderId} Delete a folder (and all its lists)
ContactsApi deleteList DELETE /contacts/lists/{listId} Delete a list
ContactsApi getAttributes GET /contacts/attributes Lists all attributes
ContactsApi getContactInfo GET /contacts/{email} Retrieves contact informations
ContactsApi getContactStats GET /contacts/{email}/campaignStats Get the campaigns statistics for a contact
ContactsApi getContacts GET /contacts Get all the contacts
ContactsApi getContactsFromList GET /contacts/lists/{listId}/contacts Get the contacts in a list
ContactsApi getFolder GET /contacts/folders/{folderId} Returns folder details
ContactsApi getFolderLists GET /contacts/folders/{folderId}/lists Get the lists in a folder
ContactsApi getFolders GET /contacts/folders Get all the folders
ContactsApi getList GET /contacts/lists/{listId} Get the details of a list
ContactsApi getLists GET /contacts/lists Get all the lists
ContactsApi importContacts POST /contacts/import Import contacts
ContactsApi removeContactFromList POST /contacts/lists/{listId}/contacts/remove Remove existing contacts from a list
ContactsApi requestContactExport POST /contacts/export Export contacts
ContactsApi updateAttribute PUT /contacts/attributes/{attributeCategory}/{attributeName} Updates contact attribute
ContactsApi updateContact PUT /contacts/{email} Updates a contact
ContactsApi updateFolder PUT /contacts/folders/{folderId} Update a contact folder
ContactsApi updateList PUT /contacts/lists/{listId} Update a list
EmailCampaignsApi createEmailCampaign POST /emailCampaigns Create an email campaign
EmailCampaignsApi deleteEmailCampaign DELETE /emailCampaigns/{campaignId} Delete an email campaign
EmailCampaignsApi emailExportRecipients POST /emailCampaigns/{campaignId}/exportRecipients Export the recipients of a campaign
EmailCampaignsApi getEmailCampaign GET /emailCampaigns/{campaignId} Get campaign informations
EmailCampaignsApi getEmailCampaigns GET /emailCampaigns Return all your created campaigns
EmailCampaignsApi sendEmailCampaignNow POST /emailCampaigns/{campaignId}/sendNow Send an email campaign id of the campaign immediately
EmailCampaignsApi sendReport POST /emailCampaigns/{campaignId}/sendReport Send the report of a campaigns
EmailCampaignsApi sendTestEmail POST /emailCampaigns/{campaignId}/sendTest Send an email campaign to your test list
EmailCampaignsApi updateCampaignStatus PUT /emailCampaigns/{campaignId}/status Update a campaign status
EmailCampaignsApi updateEmailCampaign PUT /emailCampaigns/{campaignId} Update a campaign
FoldersApi createFolder POST /contacts/folders Create a folder
FoldersApi deleteFolder DELETE /contacts/folders/{folderId} Delete a folder (and all its lists)
FoldersApi getFolder GET /contacts/folders/{folderId} Returns folder details
FoldersApi getFolderLists GET /contacts/folders/{folderId}/lists Get the lists in a folder
FoldersApi getFolders GET /contacts/folders Get all the folders
FoldersApi updateFolder PUT /contacts/folders/{folderId} Update a contact folder
ListsApi addContactToList POST /contacts/lists/{listId}/contacts/add Add existing contacts to a list
ListsApi createList POST /contacts/lists Create a list
ListsApi deleteList DELETE /contacts/lists/{listId} Delete a list
ListsApi getContactsFromList GET /contacts/lists/{listId}/contacts Get the contacts in a list
ListsApi getFolderLists GET /contacts/folders/{folderId}/lists Get the lists in a folder
ListsApi getList GET /contacts/lists/{listId} Get the details of a list
ListsApi getLists GET /contacts/lists Get all the lists
ListsApi removeContactFromList POST /contacts/lists/{listId}/contacts/remove Remove existing contacts from a list
ListsApi updateList PUT /contacts/lists/{listId} Update a list
ProcessApi getProcess GET /processes/{processId} Return the informations for a process
ProcessApi getProcesses GET /processes Return all the processes for your account
ResellerApi addCredits POST /reseller/children/{childAuthKey}/credits/add Add Email and/or SMS credits to a specific child account
ResellerApi associateIpToChild POST /reseller/children/{childAuthKey}/ips/associate Associate a dedicated IP to the child
ResellerApi createResellerChild POST /reseller/children Creates a reseller child
ResellerApi deleteResellerChild DELETE /reseller/children/{childAuthKey} Deletes a single reseller child based on the childAuthKey supplied
ResellerApi dissociateIpFromChild POST /reseller/children/{childAuthKey}/ips/dissociate Dissociate a dedicated IP to the child
ResellerApi getChildInfo GET /reseller/children/{childAuthKey} Gets the info about a specific child account
ResellerApi getResellerChilds GET /reseller/children Gets the list of all reseller's children accounts
ResellerApi removeCredits POST /reseller/children/{childAuthKey}/credits/remove Remove Email and/or SMS credits from a specific child account
ResellerApi updateResellerChild PUT /reseller/children/{childAuthKey} Updates infos of reseller's child based on the childAuthKey supplied
SendersApi createSender POST /senders Create a new sender
SendersApi deleteSender DELETE /senders/{senderId} Delete a sender
SendersApi getIps GET /senders/ips Return all the dedicated IPs for your account
SendersApi getIpsFromSender GET /senders/{senderId}/ips Return all the dedicated IPs for a sender
SendersApi getSenders GET /senders Get the list of all your senders
SendersApi updateSender PUT /senders/{senderId} Update a sender
SmsCampaignsApi createSmsCampaign POST /smsCampaigns Creates an SMS campaign
SmsCampaignsApi deleteSmsCampaign DELETE /smsCampaigns/{campaignId} Delete the SMS campaign
SmsCampaignsApi getSmsCampaign GET /smsCampaigns/{campaignId} Get an SMS campaign
SmsCampaignsApi getSmsCampaigns GET /smsCampaigns Returns the informations for all your created SMS campaigns
SmsCampaignsApi requestSmsRecipientExport POST /smsCampaigns/{campaignId}/exportRecipients Exports the recipients of the specified campaign.
SmsCampaignsApi sendSmsCampaignNow POST /smsCampaigns/{campaignId}/sendNow Send your SMS campaign immediately
SmsCampaignsApi sendSmsReport POST /smsCampaigns/{campaignId}/sendReport Send report of SMS campaigns
SmsCampaignsApi sendTestSms POST /smsCampaigns/{campaignId}/sendTest Send an SMS
SmsCampaignsApi updateSmsCampaign PUT /smsCampaigns/{campaignId} Updates an SMS campaign
SmsCampaignsApi updateSmsCampaignStatus PUT /smsCampaigns/{campaignId}/status Update the campaign status
SmtpApi createSmtpTemplate POST /smtp/templates Create an smtp template
SmtpApi deleteHardbounces POST /smtp/deleteHardbounces Delete hardbounces
SmtpApi deleteSmtpTemplate DELETE /smtp/templates/{templateId} Delete an inactive smtp template
SmtpApi getAggregatedSmtpReport GET /smtp/statistics/aggregatedReport Get your SMTP activity aggregated over a period of time
SmtpApi getEmailEventReport GET /smtp/statistics/events Get all your SMTP activity (unaggregated events)
SmtpApi getSmtpReport GET /smtp/statistics/reports Get your SMTP activity aggregated per day
SmtpApi getSmtpTemplate GET /smtp/templates/{templateId} Returns the template informations
SmtpApi getSmtpTemplates GET /smtp/templates Get the list of SMTP templates
SmtpApi sendTemplate POST /smtp/templates/{templateId}/send Send a template
SmtpApi sendTestTemplate POST /smtp/templates/{templateId}/sendTest Send a template to your test list
SmtpApi sendTransacEmail POST /smtp/email Send a transactional email
SmtpApi updateSmtpTemplate PUT /smtp/templates/{templateId} Updates an smtp templates
TransactionalSmsApi getSmsEvents GET /transactionalSMS/statistics/events Get all the SMS activity (unaggregated events)
TransactionalSmsApi getTransacAggregatedSmsReport GET /transactionalSMS/statistics/aggregatedReport Get your SMS activity aggregated over a period of time
TransactionalSmsApi getTransacSmsReport GET /transactionalSMS/statistics/reports Get your SMS activity aggregated per day
TransactionalSmsApi sendTransacSms POST /transactionalSMS/sms Send the SMS campaign to the specified mobile number
WebhooksApi createWebhook POST /webhooks Create a webhook
WebhooksApi deleteWebhook DELETE /webhooks/{webhookId} Delete a webhook
WebhooksApi getWebhook GET /webhooks/{webhookId} Get a webhook details
WebhooksApi getWebhooks GET /webhooks Get all webhooks
WebhooksApi updateWebhook PUT /webhooks/{webhookId} Update a webhook

Documentation for Models

Documentation for Authorization

Authentication schemes defined for the API:

api-key

  • Type: API key
  • API key parameter name: api-key
  • Location: HTTP header

Recommendation

It's recommended to create an instance of ApiClient per thread in a multithreaded environment to avoid any potential issues.

Support and Feedback

Be sure to visit the SendinBlue official documentation website for additional information about our API.

If you find a bug, please post the issue on Github.

As always, if you need additional assistance, drop us a note here.

You can’t perform that action at this time.