Skip to content

README.md

Latest commit

 

History

History
72 lines (61 loc) · 5.48 KB

README.md

File metadata and controls

72 lines (61 loc) · 5.48 KB

SendinBlue Ruby API

You will need to install the following module

  • json
  • httparty
  • openssl

Quickstart

  1. You will need to first get the Access key and Secret key from SendinBlue.

  2. Assuming that you have cloned this git repo. You can use this small sample script to get started

require './mailin'
m = Mailin.new("https://api.sendinblue.com/v1.0","<your access key>","<your secret key>")
m.get_campaigns()
  1. To explore more, you should visit the SendinBlue API documentation.

Available functions

Campaign calls

  • get_account() - Get your account information
  • get_campaigns(type) - Get list of all campaigns or of specific type: "classic", "trigger", "sms"
  • get_campaign(id) - Get specific campaign object
  • create_campaign(category,from_name,name,bat_sent,html_content,html_url,listid,scheduled_date,subject,from_email,reply_to,exclude_list) - Create a campaign
  • delete_campaign(id) - Delete a campaign
  • update_campaign(id,category,from_name,name,bat_sent,html_content,html_url,listid,scheduled_date,subject,from_email,reply_to,exclude_list) - Update campaign information
  • campaign_report_email(id,lang,email_subject,email_to,email_content_type,email_bcc,email_cc,email_body) - Sending reports to specific emails
  • campaign_recipients_export(id,notify_url,type) - Export recipients of a campaign
  • get_folders() - Get list of all the folder details.
  • get_folder(id) - Get all the folder details for folder with id
  • create_folder(name) - Create a folder
  • delete_folder(id) - Delete folder with folder id
  • update_folder(id,name) - Update folder with folder id
  • get_lists() - Get all the lists
  • get_list(id) - Get information about a list
  • create_list(list_name,list_parent) - Create a list
  • delete_list(id) - Delete a list
  • update_list(id,list_name,list_parent) - Updating a list
  • add_users_list(id,users) - Add users to a list
  • delete_users_list(id,users) - Delete users from a list
  • get_attributes() - Listing all attributes
  • get_attribute(id) - Listing a certain type attributes
  • create_attribute(type,data) - Creating attributes
  • delete_attribute(id,data) - Deleting attributes
  • get_user(id) - Get information about a user/email
  • create_user(attributes,blacklisted,email,listid) - Add a new user/email
  • delete_user(id) - Deleting user from db is not permitted but this action will unlink him from all lists
  • update_user(id,attributes,blacklisted,listid,listid_unlink) - Edit a user/email information
  • import_users(url,listids,notify_url,name) - Import users/emails
  • export_users(export_attrib,filter,notify_url) - Export users/emails
  • get_processes() - Get information about all background processes
  • get_process(id) - Get information about a specific process

SMTP calls

  • get_report(limit,start_date,end_date,offset,date,days,email) - Retrieve information for all report events
  • get_statistics(aggregate,tag,days,end_date,start_date) - Get aggregate statistics about emails sent
  • get_webhooks() - List registered webhooks
  • get_webhook(id) - Get information about a webhook
  • create_webhook(url,description,events) - Registering a webhook
  • delete_webhook(id) - Deleting a webhook
  • update_webhook(id,url,description,events) - Editing a webhook
  • delete_bounces(start_date,end_date,email) - Deleting bounces
  • send_email(to,subject,from,html,text,cc,bcc,replyto,attachment,headers) - Sending out a transactional email
  • send_transactional_template(id,to,cc,bcc,attr) - Send templates created on mailin, through mailin smtp.

SMS call

  • send_sms(to,from,text,web_url,tag) - Sending a SMS