sendinblue-apiv3

SendinBlue's API v3 Node.js 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. It supports promises.

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

This library is automatically generated by the Swagger Codegen project and is reviewed and maintained by SendinBlue:

• API version: 3.0.0
• Package version: 2.0.0
• Build package: io.swagger.codegen.languages.JavascriptClientCodegen

Installation

For Node.js

npm

The following recommended installation requires npm. If you are unfamiliar with npm, see the npm docs.

Then install it via:

npm install sendinblue-apiv3 --save

Local development

To use the library locally without publishing to a remote npm registry, first install the dependencies by changing into the directory containing package.json (and this README). Let's call this JAVASCRIPT_CLIENT_DIR. Then run:

npm install

Next, link it globally in npm with the following, also from JAVASCRIPT_CLIENT_DIR:

npm link

Finally, switch to the directory you want to use your sendinblue-apiv3 from, and run:

npm link /path/to/<JAVASCRIPT_CLIENT_DIR>

You should now be able to require('sendinblue-apiv3') in javascript files from the directory you ran the last command above from.

git

If the library is hosted at a git repository, e.g. https://github.com/sendinblue/APIv3-nodejs-library then install it via:

    npm install sendinblue/APIv3-nodejs-library --save

Webpack Configuration

Using Webpack you may encounter the following error: "Module not found: Error: Cannot resolve module", most certainly you should disable AMD loader. Add/merge the following section to your webpack config:

module: {
  rules: [
    {
      parser: {
        amd: false
      }
    }
  ]
}

Getting Started

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

var SendinBlueApi = require('sendinblue-apiv3');

var defaultClient = SendinBlueApi.ApiClient.instance;

// Configure API key authorization: api-key
var apiKey = defaultClient.authentications['api-key'];
apiKey.apiKey = "YOUR API KEY"

var api = new SendinBlueApi.AccountApi()
api.getAccount().then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

Documentation for API Endpoints

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

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

Documentation for Models

• SendinBlueApi.AddCredits
• SendinBlueApi.AddRemoveContactToList
• SendinBlueApi.CreaUpdateFolder
• SendinBlueApi.CreateAttribute
• SendinBlueApi.CreateAttributeEnumemaration
• SendinBlueApi.CreateChild
• SendinBlueApi.CreateContact
• SendinBlueApi.CreateEmailCampaign
• SendinBlueApi.CreateEmailCampaignRecipients
• SendinBlueApi.CreateEmailCampaignSender
• SendinBlueApi.CreateList
• SendinBlueApi.CreateModel
• SendinBlueApi.CreateSender
• SendinBlueApi.CreateSenderIps
• SendinBlueApi.CreateSenderModel
• SendinBlueApi.CreateSmsCampaign
• SendinBlueApi.CreateSmsCampaignRecipients
• SendinBlueApi.CreateSmtpEmail
• SendinBlueApi.CreateSmtpTemplate
• SendinBlueApi.CreateSmtpTemplateSender
• SendinBlueApi.CreateWebhook
• SendinBlueApi.CreatedProcessId
• SendinBlueApi.DeleteHardbounces
• SendinBlueApi.EmailExportRecipients
• SendinBlueApi.ErrorModel
• SendinBlueApi.GetAccountMarketingAutomation
• SendinBlueApi.GetAccountPlan
• SendinBlueApi.GetAccountRelay
• SendinBlueApi.GetAccountRelayData
• SendinBlueApi.GetAggregatedReport
• SendinBlueApi.GetAttributes
• SendinBlueApi.GetAttributesAttributes
• SendinBlueApi.GetAttributesEnumeration
• SendinBlueApi.GetCampaignOverview
• SendinBlueApi.GetCampaignRecipients
• SendinBlueApi.GetCampaignRecipientsExclusionLists
• SendinBlueApi.GetCampaignRecipientsLists
• SendinBlueApi.GetCampaignStats
• SendinBlueApi.GetChildInfoApiKeys
• SendinBlueApi.GetChildInfoCredits
• SendinBlueApi.GetChildInfoIps
• SendinBlueApi.GetChildInfoStatistics
• SendinBlueApi.GetChildrenList
• SendinBlueApi.GetClient
• SendinBlueApi.GetContactCampaignStats
• SendinBlueApi.GetContactCampaignStatsClicked
• SendinBlueApi.GetContactCampaignStatsLinks
• SendinBlueApi.GetContactCampaignStatsMessagesSent
• SendinBlueApi.GetContactCampaignStatsOpened
• SendinBlueApi.GetContactCampaignStatsTransacAttributes
• SendinBlueApi.GetContactCampaignStatsUnsubscriptions
• SendinBlueApi.GetContactCampaignStatsUnsubscriptionsAdminUnsubscription
• SendinBlueApi.GetContactCampaignStatsUnsubscriptionsUserUnsubscription
• SendinBlueApi.GetContactDetails
• SendinBlueApi.GetContacts
• SendinBlueApi.GetEmailCampaigns
• SendinBlueApi.GetEmailEventReport
• SendinBlueApi.GetEmailEventReportEvents
• SendinBlueApi.GetExtendedCampaignOverviewSender
• SendinBlueApi.GetExtendedCampaignStats
• SendinBlueApi.GetExtendedCampaignStatsLinksStats
• SendinBlueApi.GetExtendedClientAddress
• SendinBlueApi.GetExtendedListCampaignStats
• SendinBlueApi.GetFolder
• SendinBlueApi.GetFolderLists
• SendinBlueApi.GetFolders
• SendinBlueApi.GetIp
• SendinBlueApi.GetIpFromSender
• SendinBlueApi.GetIps
• SendinBlueApi.GetIpsFromSender
• SendinBlueApi.GetList
• SendinBlueApi.GetLists
• SendinBlueApi.GetListsFolder
• SendinBlueApi.GetListsLists
• SendinBlueApi.GetProcess
• SendinBlueApi.GetProcesses
• SendinBlueApi.GetReports
• SendinBlueApi.GetReportsReports
• SendinBlueApi.GetSendersList
• SendinBlueApi.GetSendersListIps
• SendinBlueApi.GetSendersListSenders
• SendinBlueApi.GetSmsCampaignOverview
• SendinBlueApi.GetSmsCampaignStats
• SendinBlueApi.GetSmsCampaigns
• SendinBlueApi.GetSmsEventReport
• SendinBlueApi.GetSmsEventReportEvents
• SendinBlueApi.GetSmtpTemplateOverview
• SendinBlueApi.GetSmtpTemplateOverviewSender
• SendinBlueApi.GetSmtpTemplates
• SendinBlueApi.GetStatsByDomain
• SendinBlueApi.GetTransacAggregatedSmsReport
• SendinBlueApi.GetTransacSmsReport
• SendinBlueApi.GetTransacSmsReportReports
• SendinBlueApi.GetWebhook
• SendinBlueApi.GetWebhooks
• SendinBlueApi.ManageIp
• SendinBlueApi.PostContactInfo
• SendinBlueApi.PostContactInfoContacts
• SendinBlueApi.PostSendFailed
• SendinBlueApi.PostSendSmsTestFailed
• SendinBlueApi.RemainingCreditModel
• SendinBlueApi.RemainingCreditModelChild
• SendinBlueApi.RemainingCreditModelReseller
• SendinBlueApi.RemoveCredits
• SendinBlueApi.RequestContactExport
• SendinBlueApi.RequestContactImport
• SendinBlueApi.RequestContactImportNewList
• SendinBlueApi.RequestSMSRecipientExport
• SendinBlueApi.SendEmail
• SendinBlueApi.SendEmailAttachment
• SendinBlueApi.SendReport
• SendinBlueApi.SendReportEmail
• SendinBlueApi.SendSms
• SendinBlueApi.SendSmtpEmail
• SendinBlueApi.SendSmtpEmailAttachment
• SendinBlueApi.SendSmtpEmailBcc
• SendinBlueApi.SendSmtpEmailCc
• SendinBlueApi.SendSmtpEmailReplyTo
• SendinBlueApi.SendSmtpEmailSender
• SendinBlueApi.SendSmtpEmailTo
• SendinBlueApi.SendTemplateEmail
• SendinBlueApi.SendTestEmail
• SendinBlueApi.SendTestSms
• SendinBlueApi.SendTransacSms
• SendinBlueApi.UpdateCampaignStatus
• SendinBlueApi.UpdateChild
• SendinBlueApi.UpdateContact
• SendinBlueApi.UpdateEmailCampaign
• SendinBlueApi.UpdateEmailCampaignRecipients
• SendinBlueApi.UpdateEmailCampaignSender
• SendinBlueApi.UpdateList
• SendinBlueApi.UpdateSender
• SendinBlueApi.UpdateSmsCampaign
• SendinBlueApi.UpdateSmtpTemplate
• SendinBlueApi.UpdateSmtpTemplateSender
• SendinBlueApi.UpdateWebhook
• SendinBlueApi.GetChildInfo
• SendinBlueApi.GetExtendedCampaignOverview
• SendinBlueApi.GetExtendedClient
• SendinBlueApi.GetExtendedContactDetails
• SendinBlueApi.GetExtendedList
• SendinBlueApi.GetSmsCampaign
• SendinBlueApi.GetAccount
• SendinBlueApi.GetEmailCampaign

Documentation for Authorization

api-key

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

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.