Skip to content

Latest commit

 

History

History
363 lines (322 loc) · 26.4 KB

README.md

File metadata and controls

363 lines (322 loc) · 26.4 KB
Raw

SendinBlue's API v3 Python 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.

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

  • API version: 3.0.0
  • Build package: io.swagger.codegen.languages.PythonClientCodegen

For more information, please visit https://account.sendinblue.com/support

Requirements.

Python 2.7 and 3.4+

Installation & Usage

pip install

If the python package is hosted on Github, you can install directly from Github

pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git

(you may need to run pip with root permission: sudo pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git)

Then import the package:

import sib_api_v3_sdk

Setuptools

Install via Setuptools.

python setup.py install --user

(or sudo python setup.py install to install the package for all users)

Then import the package:

import sib_api_v3_sdk

Getting Started

Please follow the installation procedure and then run the following:

from __future__ import print_function
import time
import sib_api_v3_sdk
from sib_api_v3_sdk.rest import ApiException
from pprint import pprint

# Configure API key authorization: api-key
configuration = sib_api_v3_sdk.Configuration()
configuration.api_key['api-key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['api-key'] = 'Bearer'

# create an instance of the API class
api_instance = sib_api_v3_sdk.AccountApi(sib_api_v3_sdk.ApiClient(configuration))

try:
    # Get your account informations, plans and credits details
    api_response = api_instance.get_account()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AccountApi->get_account: %s\n" % e)

Documentation for API Endpoints

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

Class Method HTTP request Description
AccountApi get_account GET /account Get your account informations, plans and credits details
AttributesApi create_attribute POST /contacts/attributes/{attributeCategory}/{attributeName} Creates contact attribute
AttributesApi delete_attribute DELETE /contacts/attributes/{attributeCategory}/{attributeName} Deletes an attribute
AttributesApi get_attributes GET /contacts/attributes Lists all attributes
AttributesApi update_attribute PUT /contacts/attributes/{attributeCategory}/{attributeName} Updates contact attribute
ContactsApi add_contact_to_list POST /contacts/lists/{listId}/contacts/add Add existing contacts to a list
ContactsApi create_attribute POST /contacts/attributes/{attributeCategory}/{attributeName} Creates contact attribute
ContactsApi create_contact POST /contacts Create a contact
ContactsApi create_folder POST /contacts/folders Create a folder
ContactsApi create_list POST /contacts/lists Create a list
ContactsApi delete_attribute DELETE /contacts/attributes/{attributeCategory}/{attributeName} Deletes an attribute
ContactsApi delete_contact DELETE /contacts/{email} Deletes a contact
ContactsApi delete_folder DELETE /contacts/folders/{folderId} Delete a folder (and all its lists)
ContactsApi delete_list DELETE /contacts/lists/{listId} Delete a list
ContactsApi get_attributes GET /contacts/attributes Lists all attributes
ContactsApi get_contact_info GET /contacts/{email} Retrieves contact informations
ContactsApi get_contact_stats GET /contacts/{email}/campaignStats Get the campaigns statistics for a contact
ContactsApi get_contacts GET /contacts Get all the contacts
ContactsApi get_contacts_from_list GET /contacts/lists/{listId}/contacts Get the contacts in a list
ContactsApi get_folder GET /contacts/folders/{folderId} Returns folder details
ContactsApi get_folder_lists GET /contacts/folders/{folderId}/lists Get the lists in a folder
ContactsApi get_folders GET /contacts/folders Get all the folders
ContactsApi get_list GET /contacts/lists/{listId} Get the details of a list
ContactsApi get_lists GET /contacts/lists Get all the lists
ContactsApi import_contacts POST /contacts/import Import contacts
ContactsApi remove_contact_from_list POST /contacts/lists/{listId}/contacts/remove Remove existing contacts from a list
ContactsApi request_contact_export POST /contacts/export Export contacts
ContactsApi update_attribute PUT /contacts/attributes/{attributeCategory}/{attributeName} Updates contact attribute
ContactsApi update_contact PUT /contacts/{email} Updates a contact
ContactsApi update_folder PUT /contacts/folders/{folderId} Update a contact folder
ContactsApi update_list PUT /contacts/lists/{listId} Update a list
EmailCampaignsApi create_email_campaign POST /emailCampaigns Create an email campaign
EmailCampaignsApi delete_email_campaign DELETE /emailCampaigns/{campaignId} Delete an email campaign
EmailCampaignsApi email_export_recipients POST /emailCampaigns/{campaignId}/exportRecipients Export the recipients of a campaign
EmailCampaignsApi get_email_campaign GET /emailCampaigns/{campaignId} Get campaign informations
EmailCampaignsApi get_email_campaigns GET /emailCampaigns Return all your created campaigns
EmailCampaignsApi send_email_campaign_now POST /emailCampaigns/{campaignId}/sendNow Send an email campaign id of the campaign immediately
EmailCampaignsApi send_report POST /emailCampaigns/{campaignId}/sendReport Send the report of a campaigns
EmailCampaignsApi send_test_email POST /emailCampaigns/{campaignId}/sendTest Send an email campaign to your test list
EmailCampaignsApi update_campaign_status PUT /emailCampaigns/{campaignId}/status Update a campaign status
EmailCampaignsApi update_email_campaign PUT /emailCampaigns/{campaignId} Update a campaign
FoldersApi create_folder POST /contacts/folders Create a folder
FoldersApi delete_folder DELETE /contacts/folders/{folderId} Delete a folder (and all its lists)
FoldersApi get_folder GET /contacts/folders/{folderId} Returns folder details
FoldersApi get_folder_lists GET /contacts/folders/{folderId}/lists Get the lists in a folder
FoldersApi get_folders GET /contacts/folders Get all the folders
FoldersApi update_folder PUT /contacts/folders/{folderId} Update a contact folder
ListsApi add_contact_to_list POST /contacts/lists/{listId}/contacts/add Add existing contacts to a list
ListsApi create_list POST /contacts/lists Create a list
ListsApi delete_list DELETE /contacts/lists/{listId} Delete a list
ListsApi get_contacts_from_list GET /contacts/lists/{listId}/contacts Get the contacts in a list
ListsApi get_folder_lists GET /contacts/folders/{folderId}/lists Get the lists in a folder
ListsApi get_list GET /contacts/lists/{listId} Get the details of a list
ListsApi get_lists GET /contacts/lists Get all the lists
ListsApi remove_contact_from_list POST /contacts/lists/{listId}/contacts/remove Remove existing contacts from a list
ListsApi update_list PUT /contacts/lists/{listId} Update a list
ProcessApi get_process GET /processes/{processId} Return the informations for a process
ProcessApi get_processes GET /processes Return all the processes for your account
ResellerApi add_credits POST /reseller/children/{childAuthKey}/credits/add Add Email and/or SMS credits to a specific child account
ResellerApi associate_ip_to_child POST /reseller/children/{childAuthKey}/ips/associate Associate a dedicated IP to the child
ResellerApi create_reseller_child POST /reseller/children Creates a reseller child
ResellerApi delete_reseller_child DELETE /reseller/children/{childAuthKey} Deletes a single reseller child based on the childAuthKey supplied
ResellerApi dissociate_ip_from_child POST /reseller/children/{childAuthKey}/ips/dissociate Dissociate a dedicated IP to the child
ResellerApi get_child_info GET /reseller/children/{childAuthKey} Gets the info about a specific child account
ResellerApi get_reseller_childs GET /reseller/children Gets the list of all reseller's children accounts
ResellerApi remove_credits POST /reseller/children/{childAuthKey}/credits/remove Remove Email and/or SMS credits from a specific child account
ResellerApi update_reseller_child PUT /reseller/children/{childAuthKey} Updates infos of reseller's child based on the childAuthKey supplied
SMSCampaignsApi create_sms_campaign POST /smsCampaigns Creates an SMS campaign
SMSCampaignsApi delete_sms_campaign DELETE /smsCampaigns/{campaignId} Delete the SMS campaign
SMSCampaignsApi get_sms_campaign GET /smsCampaigns/{campaignId} Get an SMS campaign
SMSCampaignsApi get_sms_campaigns GET /smsCampaigns Returns the informations for all your created SMS campaigns
SMSCampaignsApi request_sms_recipient_export POST /smsCampaigns/{campaignId}/exportRecipients Exports the recipients of the specified campaign.
SMSCampaignsApi send_sms_campaign_now POST /smsCampaigns/{campaignId}/sendNow Send your SMS campaign immediately
SMSCampaignsApi send_sms_report POST /smsCampaigns/{campaignId}/sendReport Send report of SMS campaigns
SMSCampaignsApi send_test_sms POST /smsCampaigns/{campaignId}/sendTest Send an SMS
SMSCampaignsApi update_sms_campaign PUT /smsCampaigns/{campaignId} Updates an SMS campaign
SMSCampaignsApi update_sms_campaign_status PUT /smsCampaigns/{campaignId}/status Update the campaign status
SMTPApi create_smtp_template POST /smtp/templates Create an smtp template
SMTPApi delete_hardbounces POST /smtp/deleteHardbounces Delete hardbounces
SMTPApi delete_smtp_template DELETE /smtp/templates/{templateId} Delete an inactive smtp template
SMTPApi get_aggregated_smtp_report GET /smtp/statistics/aggregatedReport Get your SMTP activity aggregated over a period of time
SMTPApi get_email_event_report GET /smtp/statistics/events Get all your SMTP activity (unaggregated events)
SMTPApi get_smtp_report GET /smtp/statistics/reports Get your SMTP activity aggregated per day
SMTPApi get_smtp_template GET /smtp/templates/{templateId} Returns the template informations
SMTPApi get_smtp_templates GET /smtp/templates Get the list of SMTP templates
SMTPApi send_template POST /smtp/templates/{templateId}/send Send a template
SMTPApi send_test_template POST /smtp/templates/{templateId}/sendTest Send a template to your test list
SMTPApi send_transac_email POST /smtp/email Send a transactional email
SMTPApi update_smtp_template PUT /smtp/templates/{templateId} Updates an smtp templates
SendersApi create_sender POST /senders Create a new sender
SendersApi delete_sender DELETE /senders/{senderId} Delete a sender
SendersApi get_ips GET /senders/ips Return all the dedicated IPs for your account
SendersApi get_ips_from_sender GET /senders/{senderId}/ips Return all the dedicated IPs for a sender
SendersApi get_senders GET /senders Get the list of all your senders
SendersApi update_sender PUT /senders/{senderId} Update a sender
TransactionalSMSApi get_sms_events GET /transactionalSMS/statistics/events Get all the SMS activity (unaggregated events)
TransactionalSMSApi get_transac_aggregated_sms_report GET /transactionalSMS/statistics/aggregatedReport Get your SMS activity aggregated over a period of time
TransactionalSMSApi get_transac_sms_report GET /transactionalSMS/statistics/reports Get your SMS activity aggregated per day
TransactionalSMSApi send_transac_sms POST /transactionalSMS/sms Send the SMS campaign to the specified mobile number
WebhooksApi create_webhook POST /webhooks Create a webhook
WebhooksApi delete_webhook DELETE /webhooks/{webhookId} Delete a webhook
WebhooksApi get_webhook GET /webhooks/{webhookId} Get a webhook details
WebhooksApi get_webhooks GET /webhooks Get all webhooks
WebhooksApi update_webhook PUT /webhooks/{webhookId} Update a webhook

Documentation For Models

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.

Author

contact@sendinblue.com