We Love Software!
BombBomb maintains a modest and growing JSON API. We invite you to try a few calls and see what you
can dream up! Signup for your free developer account and if you have any questions or problems, don’t hesitate to contact
support@bombbomb.com
Before you get started, .
Javascript Wrapper
The easiest way to get started with BombBomb’s API on your web site or application is to use our Javascript wrapper, BBCore.
BBCore is open source and available at https://github.com/bombbomb/BBCore
BBCore wraps the functionality exposed below into a simple Javascript interface allowing you to offer BombBomb features on your site or application
without having to write server-side code.
.Net Wrapper
We also offer a modest .Net wrapper at https://github.com/bombbomb/BombBombDotNet It’s simple, but we’re happy to answer questions, and accept contributions.
Go Package
Our friends at RealGeeks put together a nice Go Package to get you started at: https://github.com/RealGeeks/bombbomb-go Go for it!
Ruby Gem
Our friends at FiveStreet put together a simple Ruby Gem to get you started at: https://github.com/guillec/bomb_bomb Give it a shot, and let us know how it goes.
Endpoint
Our API is accessed via HTTP GET or POST requests to the url:
https://app.bombbomb.com/app/api/api.php
Responses from the API are JSON encoded objects with three root properties:
status, methodName, and info.
status will be either ‘success’ or ‘failure’, ‘methodName’ will be the same as what’s passed in the
‘method’ parameter, and ‘info’ will contain information about the action varying by method.
Parameters
Parameters are passed either by GET or POST. We STRONGLY recommend POSTing your parameters inside an
encrypted HTTPS request.
You control what action you’re taking using the method parameter. The majority of this document
is categorized by method.
Credentials
Along with the method you request, you will also be passing in credentials to
access the service. This can be handled in one of two ways:
- email and pw – These correspond to your BombBomb account’s email address and password.
- api_key – The api_key can be found under the integration tab under your account settings.
Example
An example of the first method below, IsValidLogin, would look something like this:
https://app.bombbomb.com/app/api/api.php?method=IsValidLogin&email=youremail@domain.com&pw=yourpassword
Try entering your actual credentials, to get a successful response! Then move on to the methods detailed below.
Once more, please don’t pass your password in the querystring as a GET parameter in your final application;
use HTTPS and use POST to protect your credentials, payload and response.
For any method except IsValidLogin, you can replace email and pw with api_key.
Methods
IsValidLogin
Checks if entered credentials are valid.
Parameters
- email – The email address associated with your account.
- pw – The password associated with your account.
GetVideos
Returns a list of all videos in the account.
Parameters
- email – The email address associated with your account.
- pw – The password associated with your account.
AddVideo
Uploads a video file to the account. Must be POSTed.
Parameters
- email – The email address associated with your account.
- pw – The password associated with your account.
- name – The name of the new video.
- videoFile – The video binary itself, POSTed as an attachment.
- description – Optional. A description of the video.
VideoQuickSend
Sends a simple email with a video automatically inserted.
Parameters
- email – The email address associated with your account.
- pw – The password associated with your account.
- email_addresses – A semicolon-delimited list of destination email addresses.
- list_id – One list_id to send the video to. list_ids can be found via GetLists
- video_id – The id of the video to quick send.
- subject – The subject line for the email.
- mobile_message – The body of the email
GetLists
Returns a list of all Lists in the account.
Parameters
- email – The email address associated with your account.
- pw – The password associated with your account.
CreateList
Creates a new list and returns its details
Parameters
- email – The email address associated with your account.
- pw – The password associated with your account.
- name – The name you want to give the new list.
DeleteList
Deletes a list and all the contacts on it.
Parameters
- email – The email address associated with your account.
- pw – The password associated with your account.
- list_id – The id of the list you want to delete.
GetListContacts
Returns all contacts on a list.
Parameters
- email – The email address associated with your account.
- pw – The password associated with your account.
- list_id – The id of the list whose contacts you are requesting.
AddContact
Adds a contact to a list with optional extended parameters.
Parameters
- email – The email address associated with your account.
- pw – The password associated with your account.
- eml – The email address of the contact (Must be valid and sendable)
- firstname – Optional. The first name of the contact
- lastname – Optional. The last name of the contact
- phone_number – Optional. The phone number of the contact
- address_line_1 – Optional. The address of the contact
- address_line_2 – Optional. The address of the contact
- city – Optional. The city of the contact
- state – Optional. The state of the contact
- country – Optional. The country of the contact
- postal_code – Optional. The postal code of the contact
- company – Optional. The company of the contact
- position – Optional. The position of the contact
- comments – Optional. Comment about the contact
- Custom Fields – Optional. Use the GetContactFields method to get a list of custom fields. You can pass through these custom fields using their ‘field_name’ as the parameter name.
- listlist – A semicolon delimited list of list ids to add the contact to.
UpdateContact
Updates fields for a contact based on the email address
Parameters
- email – The email address associated with your account.
- pw – The password associated with your account.
- eml – The email address of the contact
- firstname – Optional. The first name of the contact
- lastname – Optional. The last name of the contact
- phone_number – Optional. The phone number of the contact
- address_line_1 – Optional. The address of the contact
- address_line_2 – Optional. The address of the contact
- city – Optional. The city of the contact
- state – Optional. The state of the contact
- country – Optional. The country of the contact
- postal_code – Optional. The postal code of the contact
- company – Optional. The company of the contact
- position – Optional. The position of the contact
- comments – Optional. Comment about the contact
- Custom Fields – Optional. Use the GetContactFields method to get a list of custom fields. You can pass through these custom fields using their ‘field_name’ as the parameter name.
- listlist – A semicolon delimited list of list ids to add the contact to.
GetContact
Updates fields for a contact based on the email address
Parameters
- email – The email address associated with your account.
- pw – The password associated with your account.
- contact_id – The id of the contact you would like to retrieve.
- eml – The email address of the contact you would like to retrieve.
SuppressEmails
Suppresses all email addresses
Parameters
- email – The email address associated with your account.
- pw – The password associated with your account.
- emailAddresses – Comma delimited list of email addresses to be suppressed.
AddEmailToList
Adds a single email address to a single list
Parameters
- email – The email address associated with your account.
- pw – The password associated with your account.
- new_email_address – The email address to be added to the list.
- list_id – The id of the list to add the email address to.
RemoveEmailFromList
Removes a single email address from a single list
Parameters
- email – The email address associated with your account.
- pw – The password associated with your account.
- new_email_address – The email address to be removed from the list.
- list_id – The id of the list to remove the email address from.
GetContactFields
Gets a list of standard and custom fields available for contacts
Parameters
- email – The email address associated with your account.
- pw – The password associated with your account.
importCsvToList
Imports many contacts from a CSV file to the requested list. This method will return immediately, while the actual import will happen in another process. You can use the GetListProcessingStatus method to monitor import progress.
Parameters
- email – The email address associated with your account.
- pw – The password associated with your account.
- list_id – The id of the list you would like to import these contacts to. Use GetLists method to find list ids.
- fields – Fields is an ordered comma-delimited list of field_names in the CSV file. These field names can be found with the GetContactFields method.
- csv – The csv field should contain the POSTed csv file itself.
GetListProcessingStatus
Returns the status of a list import. There will be two properties, status and message. Status will be either 1 for importing, or 0 for not importing.
Parameters
- email – The email address associated with your account.
- pw – The password associated with your account.
- list_id – The id of the list to check.
GetEmails
Returns a list of all emails in the account.
Parameters
- email – The email address associated with your account.
- pw – The password associated with your account.
GetEmailTags
Returns a list of email tag names and ids.
Parameters
- email – The email address associated with your account.
- pw – The password associated with your account.
GetAllEmailsByTag
Returns a list of emails that have the specified tag.
Parameters
- email – The email address associated with your account.
- pw – The password associated with your account.
- tagId – The id of the tag category. Can be acquired via GetEmailTags.
SendEmailToEmailAddress
Sends an existing email to an address.
Parameters
- email – The email address associated with your account.
- pw – The password associated with your account.
- email_id – The id of the email you would like to send.
- email_address – The email address you wish to send the email to.
SendCustomVideoEmail
Sends a custom-formatted email to addresses.
Parameters
- email – The email address associated with your account.
- pw – The password associated with your account.
- emailId – The id of the email you would like to send this as.
- emailAddresses – A semicolon-delimited list of email addresses to send to.
- htmlContent – The HTML of the email you wish to send.
- subject – The subject line of the email.
- fromName – Optional. The name to send from. Default is the account profile information.
- fromEmail – Optional. The email address to send from. Default is the account profile information
- share – Optional. Boolean. If the email should contain social sharing icons. Defaults to true
emailTracking
Retrieves results of email sends.
Parameters
- email – The email address associated with your account.
- pw – The password associated with your account.
- action – The type of tracking request you are making. Available actions:
- listJobs – Requires email_id, lists all jobs for the email.
- getAggregateStatsForAllJobs – Requires email_id, get summarized numbers for all sends for one email.
- getAggregateStatsForJob – Requires job_id, get summarized numbers for one email job.
- getPerContactDetailForAllJobs – Requires email_id, gets detailed interaction data for all sends for one email.
- getPerContactDetailForJob – Requires job_id, gets detailed interaction data for one email job.
- email_id – Conditionally Optional. The id of the email you would like to track.
- job_id – Conditionally Optional. The id of the email job you would like to track.
GetDrips
Returns a list of drips in an account
Parameters
- email – The email address associated with your account.
- pw – The password associated with your account.
addToDrip
Adds an email address to a drip.
Parameters
- d – The id of the Drip to add the email address to.
- e – The email address to add to the drip.
removeFromDrip
Removes an email address from a drip.
Parameters
- d – The id of the drip to add the email address to.
- e – The email address to add to the drip.