/APIv3-python-library

SendinBlue's python library for API v3

Primary LanguagePythonMIT LicenseMIT

Our library is now compatible with python 3.7 . Please use: https://github.com/sendinblue/APIv3-python-library/tree/v6.1.0

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:

Requirements.

Compatible from Python version 2.7 to 3.5+

Installation & Usage

pip install

The package is available by running :

pip install sib-api-v3-sdk

(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'
# Configure API key authorization: partner-key
configuration = sib_api_v3_sdk.Configuration()
configuration.api_key['partner-key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['partner-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 information, plan 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 information, plan and credits details
CompaniesApi companies_attributes_get GET /companies/attributes Get company attributes
CompaniesApi companies_get GET /companies Get all companies
CompaniesApi companies_id_delete DELETE /companies/{id} Delete a company
CompaniesApi companies_id_get GET /companies/{id} Get a company
CompaniesApi companies_id_patch PATCH /companies/{id} Update a company
CompaniesApi companies_link_unlink_id_patch PATCH /companies/link-unlink/{id} Link and Unlink company with contacts and deals
CompaniesApi companies_post POST /companies Create a company
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} Create contact attribute
ContactsApi create_contact POST /contacts Create a contact
ContactsApi create_doi_contact POST /contacts/doubleOptinConfirmation Create Contact via DOI (Double-Opt-In) Flow
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} Delete an attribute
ContactsApi delete_contact DELETE /contacts/{identifier} Delete 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 List all attributes
ContactsApi get_contact_info GET /contacts/{identifier} Get a contact's details
ContactsApi get_contact_stats GET /contacts/{identifier}/campaignStats Get email 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 contacts in a list
ContactsApi get_folder GET /contacts/folders/{folderId} Returns a folder's details
ContactsApi get_folder_lists GET /contacts/folders/{folderId}/lists Get lists in a folder
ContactsApi get_folders GET /contacts/folders Get all folders
ContactsApi get_list GET /contacts/lists/{listId} Get a list's details
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 Delete a contact from a list
ContactsApi request_contact_export POST /contacts/export Export contacts
ContactsApi update_attribute PUT /contacts/attributes/{attributeCategory}/{attributeName} Update contact attribute
ContactsApi update_batch_contacts POST /contacts/batch Update multiple contacts
ContactsApi update_contact PUT /contacts/{identifier} Update a contact
ContactsApi update_folder PUT /contacts/folders/{folderId} Update a folder
ContactsApi update_list PUT /contacts/lists/{listId} Update a list
ConversationsApi conversations_agent_online_ping_post POST /conversations/agentOnlinePing Sets agent’s status to online for 2-3 minutes
ConversationsApi conversations_messages_id_delete DELETE /conversations/messages/{id} Delete a message sent by an agent
ConversationsApi conversations_messages_id_get GET /conversations/messages/{id} Get a message
ConversationsApi conversations_messages_id_put PUT /conversations/messages/{id} Update a message sent by an agent
ConversationsApi conversations_messages_post POST /conversations/messages Send a message as an agent
ConversationsApi conversations_pushed_messages_id_delete DELETE /conversations/pushedMessages/{id} Delete an automated message
ConversationsApi conversations_pushed_messages_id_get GET /conversations/pushedMessages/{id} Get an automated message
ConversationsApi conversations_pushed_messages_id_put PUT /conversations/pushedMessages/{id} Update an automated message
ConversationsApi conversations_pushed_messages_post POST /conversations/pushedMessages Send an automated message to a visitor
DealsApi crm_attributes_deals_get GET /crm/attributes/deals Get deal attributes
DealsApi crm_deals_get GET /crm/deals Get all deals
DealsApi crm_deals_id_delete DELETE /crm/deals/{id} Delete a deal
DealsApi crm_deals_id_get GET /crm/deals/{id} Get a deal
DealsApi crm_deals_id_patch PATCH /crm/deals/{id} Update a deal
DealsApi crm_deals_link_unlink_id_patch PATCH /crm/deals/link-unlink/{id} Link and Unlink a deal with contacts and companies
DealsApi crm_deals_post POST /crm/deals Create a deal
DealsApi crm_pipeline_details_get GET /crm/pipeline/details Get pipeline stages
EcommerceApi create_batch_order POST /orders/status/batch Create orders in batch
EcommerceApi create_order POST /orders/status Managing the status of the order
EcommerceApi create_update_batch_category POST /categories/batch Create categories in batch
EcommerceApi create_update_batch_products POST /products/batch Create products in batch
EcommerceApi create_update_category POST /categories Create/Update a category
EcommerceApi create_update_product POST /products Create/Update a product
EcommerceApi ecommerce_activate_post POST /ecommerce/activate Activate the eCommerce app
EcommerceApi get_categories GET /categories Return all your categories
EcommerceApi get_category_info GET /categories/{id} Get a category details
EcommerceApi get_product_info GET /products/{id} Get a product's details
EcommerceApi get_products GET /products Return all your products
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 an email campaign
EmailCampaignsApi get_ab_test_campaign_result GET /emailCampaigns/{campaignId}/abTestCampaignResult Get an A/B test email campaign results
EmailCampaignsApi get_email_campaign GET /emailCampaigns/{campaignId} Get an email campaign report
EmailCampaignsApi get_email_campaigns GET /emailCampaigns Return all your created email campaigns
EmailCampaignsApi get_shared_template_url GET /emailCampaigns/{campaignId}/sharedUrl Get a shared template url
EmailCampaignsApi send_email_campaign_now POST /emailCampaigns/{campaignId}/sendNow Send an email campaign immediately, based on campaignId
EmailCampaignsApi send_report POST /emailCampaigns/{campaignId}/sendReport Send the report of a campaign
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 an email campaign status
EmailCampaignsApi update_email_campaign PUT /emailCampaigns/{campaignId} Update an email campaign
EmailCampaignsApi upload_image_to_gallery POST /emailCampaigns/images Upload an image to your account's image gallery
ExternalFeedsApi create_external_feed POST /feeds Create an external feed
ExternalFeedsApi delete_external_feed DELETE /feeds/{uuid} Delete an external feed
ExternalFeedsApi get_all_external_feeds GET /feeds Fetch all external feeds
ExternalFeedsApi get_external_feed_by_uuid GET /feeds/{uuid} Get an external feed by UUID
ExternalFeedsApi update_external_feed PUT /feeds/{uuid} Update an external feed
FilesApi crm_files_get GET /crm/files Get all files
FilesApi crm_files_id_data_get GET /crm/files/{id}/data Get file details
FilesApi crm_files_id_delete DELETE /crm/files/{id} Delete a file
FilesApi crm_files_id_get GET /crm/files/{id} Download a file
FilesApi crm_files_post POST /crm/files Upload a file
InboundParsingApi get_inbound_email_attachment GET /inbound/attachments/{downloadToken} Retrieve inbound attachment with download token.
InboundParsingApi get_inbound_email_events GET /inbound/events Get the list of all the events for the received emails.
InboundParsingApi get_inbound_email_events_by_uuid GET /inbound/events/{uuid} Fetch all events history for one particular received email.
MasterAccountApi corporate_master_account_get GET /corporate/masterAccount Get the details of requested master account
MasterAccountApi corporate_sub_account_get GET /corporate/subAccount Get the list of all the sub-accounts of the master account.
MasterAccountApi corporate_sub_account_id_delete DELETE /corporate/subAccount/{id} Delete a sub-account
MasterAccountApi corporate_sub_account_id_get GET /corporate/subAccount/{id} Get sub-account details
MasterAccountApi corporate_sub_account_id_plan_put PUT /corporate/subAccount/{id}/plan Update sub-account plan
MasterAccountApi corporate_sub_account_key_post POST /corporate/subAccount/key Create an API key for a sub-account
MasterAccountApi corporate_sub_account_post POST /corporate/subAccount Create a new sub-account under a master account.
MasterAccountApi corporate_sub_account_sso_token_post POST /corporate/subAccount/ssoToken Generate SSO token to access Sendinblue
NotesApi crm_notes_get GET /crm/notes Get all notes
NotesApi crm_notes_id_delete DELETE /crm/notes/{id} Delete a note
NotesApi crm_notes_id_get GET /crm/notes/{id} Get a note
NotesApi crm_notes_id_patch PATCH /crm/notes/{id} Update a note
NotesApi crm_notes_post POST /crm/notes Create a note
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/{childIdentifier}/credits/add Add Email and/or SMS credits to a specific child account
ResellerApi associate_ip_to_child POST /reseller/children/{childIdentifier}/ips/associate Associate a dedicated IP to the child
ResellerApi create_child_domain POST /reseller/children/{childIdentifier}/domains Create a domain for a child account
ResellerApi create_reseller_child POST /reseller/children Creates a reseller child
ResellerApi delete_child_domain DELETE /reseller/children/{childIdentifier}/domains/{domainName} Delete the sender domain of the reseller child based on the childIdentifier and domainName passed
ResellerApi delete_reseller_child DELETE /reseller/children/{childIdentifier} Delete a single reseller child based on the child identifier supplied
ResellerApi dissociate_ip_from_child POST /reseller/children/{childIdentifier}/ips/dissociate Dissociate a dedicated IP to the child
ResellerApi get_child_account_creation_status 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
ResellerApi get_child_domains GET /reseller/children/{childIdentifier}/domains Get all sender domains for a specific child account
ResellerApi get_child_info GET /reseller/children/{childIdentifier} Get a child account's details
ResellerApi get_reseller_childs GET /reseller/children Get the list of all children accounts
ResellerApi get_sso_token GET /reseller/children/{childIdentifier}/auth Get session token to access Sendinblue (SSO)
ResellerApi remove_credits POST /reseller/children/{childIdentifier}/credits/remove Remove Email and/or SMS credits from a specific child account
ResellerApi update_child_account_status PUT /reseller/children/{childIdentifier}/accountStatus Update info of reseller's child account status based on the childIdentifier supplied
ResellerApi update_child_domain PUT /reseller/children/{childIdentifier}/domains/{domainName} Update the sender domain of reseller's child based on the childIdentifier and domainName passed
ResellerApi update_reseller_child PUT /reseller/children/{childIdentifier} Update info of reseller's child based on the child identifier supplied
SMSCampaignsApi create_sms_campaign POST /smsCampaigns Creates an SMS campaign
SMSCampaignsApi delete_sms_campaign DELETE /smsCampaigns/{campaignId} Delete an SMS campaign
SMSCampaignsApi get_sms_campaign GET /smsCampaigns/{campaignId} Get an SMS campaign
SMSCampaignsApi get_sms_campaigns GET /smsCampaigns Returns the information for all your created SMS campaigns
SMSCampaignsApi request_sms_recipient_export POST /smsCampaigns/{campaignId}/exportRecipients Export an SMS campaign's recipients
SMSCampaignsApi send_sms_campaign_now POST /smsCampaigns/{campaignId}/sendNow Send your SMS campaign immediately
SMSCampaignsApi send_sms_report POST /smsCampaigns/{campaignId}/sendReport Send an SMS campaign's report
SMSCampaignsApi send_test_sms POST /smsCampaigns/{campaignId}/sendTest Send a test SMS campaign
SMSCampaignsApi update_sms_campaign PUT /smsCampaigns/{campaignId} Update an SMS campaign
SMSCampaignsApi update_sms_campaign_status PUT /smsCampaigns/{campaignId}/status Update a campaign's status
SendersApi create_sender POST /senders Create a new sender
SendersApi delete_sender DELETE /senders/{senderId} Delete a sender
SendersApi get_ips GET /senders/ips Get all the dedicated IPs for your account
SendersApi get_ips_from_sender GET /senders/{senderId}/ips Get 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
TasksApi crm_tasks_get GET /crm/tasks Get all tasks
TasksApi crm_tasks_id_delete DELETE /crm/tasks/{id} Delete a task
TasksApi crm_tasks_id_get GET /crm/tasks/{id} Get a task
TasksApi crm_tasks_id_patch PATCH /crm/tasks/{id} Update a task
TasksApi crm_tasks_post POST /crm/tasks Create a task
TasksApi crm_tasktypes_get GET /crm/tasktypes Get all task types
TransactionalSMSApi get_sms_events GET /transactionalSMS/statistics/events Get all your 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 SMS message to a mobile number
TransactionalWhatsAppApi get_whatsapp_event_report GET /whatsapp/statistics/events Get all your WhatsApp activity (unaggregated events)
TransactionalWhatsAppApi send_whatsapp_message POST /whatsapp/sendMessage Send a WhatsApp message
TransactionalEmailsApi block_new_domain POST /smtp/blockedDomains Add a new domain to the list of blocked domains
TransactionalEmailsApi create_smtp_template POST /smtp/templates Create an email template
TransactionalEmailsApi delete_blocked_domain DELETE /smtp/blockedDomains/{domain} Unblock an existing domain from the list of blocked domains
TransactionalEmailsApi delete_hardbounces POST /smtp/deleteHardbounces Delete hardbounces
TransactionalEmailsApi delete_scheduled_email_by_id DELETE /smtp/email/{identifier} Delete scheduled emails by batchId or messageId
TransactionalEmailsApi delete_smtp_template DELETE /smtp/templates/{templateId} Delete an inactive email template
TransactionalEmailsApi get_aggregated_smtp_report GET /smtp/statistics/aggregatedReport Get your transactional email activity aggregated over a period of time
TransactionalEmailsApi get_blocked_domains GET /smtp/blockedDomains Get the list of blocked domains
TransactionalEmailsApi get_email_event_report GET /smtp/statistics/events Get all your transactional email activity (unaggregated events)
TransactionalEmailsApi get_scheduled_email_by_batch_id GET /smtp/emailStatus/{batchId} Fetch scheduled emails by batchId
TransactionalEmailsApi get_scheduled_email_by_message_id GET /smtp/emailStatus/{messageId} Fetch scheduled email by messageId
TransactionalEmailsApi get_smtp_report GET /smtp/statistics/reports Get your transactional email activity aggregated per day
TransactionalEmailsApi get_smtp_template GET /smtp/templates/{templateId} Returns the template information
TransactionalEmailsApi get_smtp_templates GET /smtp/templates Get the list of email templates
TransactionalEmailsApi get_transac_blocked_contacts GET /smtp/blockedContacts Get the list of blocked or unsubscribed transactional contacts
TransactionalEmailsApi get_transac_email_content GET /smtp/emails/{uuid} Get the personalized content of a sent transactional email
TransactionalEmailsApi get_transac_emails_list GET /smtp/emails Get the list of transactional emails on the basis of allowed filters
TransactionalEmailsApi send_test_template POST /smtp/templates/{templateId}/sendTest Send a template to your test list
TransactionalEmailsApi send_transac_email POST /smtp/email Send a transactional email
TransactionalEmailsApi smtp_blocked_contacts_email_delete DELETE /smtp/blockedContacts/{email} Unblock or resubscribe a transactional contact
TransactionalEmailsApi smtp_log_message_id_delete DELETE /smtp/log/{messageId} Delete an SMTP transactional log
TransactionalEmailsApi update_smtp_template PUT /smtp/templates/{templateId} Update an email template
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
WhatsappCampaignsApi delete_whatsapp_campaign DELETE /whatsappCampaigns/{campaignId} Delete a Whatsapp campaign
WhatsappCampaignsApi get_whatsapp_campaign GET /whatsappCampaigns/{campaignId} Get a Whatsapp campaign
WhatsappCampaignsApi get_whatsapp_templates GET /whatsappCampaigns/template-list Return all your created whatsapp templates

Documentation For Models

Documentation For Authorization

api-key

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

partner-key

  • Type: API key
  • API key parameter name: partner-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