BombBomb::EmailsApi

All URIs are relative to https://api.bombbomb.com/v2

Method	HTTP request	Description
create_printing_press_email	POST /emails/print	Create an Email with Printing Press
get_all_templates_for_current_user	GET /emails/templates	Get all user templates
get_email_tracking	GET /emails/{emailId}/tracking	Get Email Tracking
get_email_tracking_interactions	GET /emails/{emailId}/tracking/interactions	Get Email Tracking Interactions
get_hourly_email_tracking	GET /emails/{emailId}/tracking/hourly	Get Hourly Email Tracking
get_live_fire_data	GET /emails/livefire	Get livefire feed data
get_quick_send_templates	GET /emails/quicksend/templates	Get all quicksend templates
get_template_html_for_template_id	GET /emails/templates/{templateId}/html	Get the HTML for a given template
get_video_quick_sender_data	GET /emails/quicksend	Get quicksend data
save_quick_sender_settings	POST /emails/quicksend/settings	Save quicksender settings
video_quick_sender	POST /emails/quicksend	Send a quicksend email

create_printing_press_email

create_printing_press_email(template_id, content, opts)

Create an Email with Printing Press

Prints an email using the template id and content to the users account.If a video id is included, it will replace any video placeholders with that video.

Example

# load the gem
require 'bombbomb'
# setup authorization
BombBomb.configure do |config|
  # Configure OAuth2 access token for authorization: BBOAuth2
  config.access_token = 'YOUR ACCESS TOKEN'
end

api_instance = BombBomb::EmailsApi.new

template_id = "template_id_example" # String | The template id to be printed.

content = "content_example" # String | The content of the email.

opts = { 
  email_id: "email_id_example", # String | The email id to be printed to.
  video_id: "video_id_example", # String | A video to replace video place holders with.
  subject_line: "subject_line_example" # String | The subject line to be printed.
}

begin
  #Create an Email with Printing Press
  api_instance.create_printing_press_email(template_id, content, opts)
rescue BombBomb::ApiError => e
  puts "Exception when calling EmailsApi->create_printing_press_email: #{e}"
end

Parameters

Name	Type	Description	Notes
template_id	String	The template id to be printed.
content	String	The content of the email.
email_id	String	The email id to be printed to.	[optional]
video_id	String	A video to replace video place holders with.	[optional]
subject_line	String	The subject line to be printed.	[optional]

Return type

nil (empty response body)

Authorization

BBOAuth2

HTTP request headers

Content-Type: application/x-www-form-urlencoded
Accept: application/json

get_all_templates_for_current_user

get_all_templates_for_current_user(opts)

Get all user templates

Get all templates accessible to the current user

Example

# load the gem
require 'bombbomb'
# setup authorization
BombBomb.configure do |config|
  # Configure OAuth2 access token for authorization: BBOAuth2
  config.access_token = 'YOUR ACCESS TOKEN'
end

api_instance = BombBomb::EmailsApi.new

opts = { 
  quick_send_only: true # BOOLEAN | Whether to return only quick send templates.
}

begin
  #Get all user templates
  api_instance.get_all_templates_for_current_user(opts)
rescue BombBomb::ApiError => e
  puts "Exception when calling EmailsApi->get_all_templates_for_current_user: #{e}"
end

Parameters

Name	Type	Description	Notes
quick_send_only	BOOLEAN	Whether to return only quick send templates.	[optional]

Return type

nil (empty response body)

Authorization

BBOAuth2

HTTP request headers

Content-Type: application/x-www-form-urlencoded
Accept: application/json

get_email_tracking

get_email_tracking(email_id, opts)

Get Email Tracking

Get Tracking data for all sends of an Email

Example

# load the gem
require 'bombbomb'
# setup authorization
BombBomb.configure do |config|
  # Configure OAuth2 access token for authorization: BBOAuth2
  config.access_token = 'YOUR ACCESS TOKEN'
end

api_instance = BombBomb::EmailsApi.new

email_id = "email_id_example" # String | ID of the email

opts = { 
  job_id: "job_id_example" # String | ID of the Job (or null for all jobs)
}

begin
  #Get Email Tracking
  api_instance.get_email_tracking(email_id, opts)
rescue BombBomb::ApiError => e
  puts "Exception when calling EmailsApi->get_email_tracking: #{e}"
end

Parameters

Name	Type	Description	Notes
email_id	String	ID of the email
job_id	String	ID of the Job (or null for all jobs)	[optional]

Return type

nil (empty response body)

Authorization

BBOAuth2

HTTP request headers

Content-Type: application/x-www-form-urlencoded
Accept: application/json

get_email_tracking_interactions

get_email_tracking_interactions(email_id, opts)

Get Email Tracking Interactions

Get Contact detail interactions for an Email

Example

# load the gem
require 'bombbomb'
# setup authorization
BombBomb.configure do |config|
  # Configure OAuth2 access token for authorization: BBOAuth2
  config.access_token = 'YOUR ACCESS TOKEN'
end

api_instance = BombBomb::EmailsApi.new

email_id = "email_id_example" # String | ID of the email

opts = { 
  job_id: "job_id_example", # String | ID of the Job (or null for all jobs)
  interaction_type: "interaction_type_example", # String | Interaction type to order and filter by
  search_term: "search_term_example" # String | Search term to filer by
}

begin
  #Get Email Tracking Interactions
  api_instance.get_email_tracking_interactions(email_id, opts)
rescue BombBomb::ApiError => e
  puts "Exception when calling EmailsApi->get_email_tracking_interactions: #{e}"
end

Parameters

Name	Type	Description	Notes
email_id	String	ID of the email
job_id	String	ID of the Job (or null for all jobs)	[optional]
interaction_type	String	Interaction type to order and filter by	[optional]
search_term	String	Search term to filer by	[optional]

Return type

nil (empty response body)

Authorization

BBOAuth2

HTTP request headers

Content-Type: application/x-www-form-urlencoded
Accept: application/json

get_hourly_email_tracking

get_hourly_email_tracking(email_id, opts)

Get Hourly Email Tracking

Get Tracking data for an Email, broken down by the hour and filterable by an Interaction type

Example

# load the gem
require 'bombbomb'
# setup authorization
BombBomb.configure do |config|
  # Configure OAuth2 access token for authorization: BBOAuth2
  config.access_token = 'YOUR ACCESS TOKEN'
end

api_instance = BombBomb::EmailsApi.new

email_id = "email_id_example" # String | ID of the email

opts = { 
  job_id: "job_id_example", # String | ID of the Job (or null for all jobs)
  interaction_type: "interaction_type_example" # String | Interaction type to filter by
}

begin
  #Get Hourly Email Tracking
  api_instance.get_hourly_email_tracking(email_id, opts)
rescue BombBomb::ApiError => e
  puts "Exception when calling EmailsApi->get_hourly_email_tracking: #{e}"
end

Parameters

Name	Type	Description	Notes
email_id	String	ID of the email
job_id	String	ID of the Job (or null for all jobs)	[optional]
interaction_type	String	Interaction type to filter by	[optional]

Return type

nil (empty response body)

Authorization

BBOAuth2

HTTP request headers

Content-Type: application/x-www-form-urlencoded
Accept: application/json

get_live_fire_data

get_live_fire_data

Get livefire feed data

Get the user data for the live fire feed emails

Example

# load the gem
require 'bombbomb'
# setup authorization
BombBomb.configure do |config|
  # Configure OAuth2 access token for authorization: BBOAuth2
  config.access_token = 'YOUR ACCESS TOKEN'
end

api_instance = BombBomb::EmailsApi.new

begin
  #Get livefire feed data
  api_instance.get_live_fire_data
rescue BombBomb::ApiError => e
  puts "Exception when calling EmailsApi->get_live_fire_data: #{e}"
end

Parameters

This endpoint does not need any parameter.

Return type

nil (empty response body)

Authorization

BBOAuth2

HTTP request headers

Content-Type: application/x-www-form-urlencoded
Accept: application/json

get_quick_send_templates

get_quick_send_templates

Get all quicksend templates

Get all quicksend templates accessible to the user.

Example

# load the gem
require 'bombbomb'
# setup authorization
BombBomb.configure do |config|
  # Configure OAuth2 access token for authorization: BBOAuth2
  config.access_token = 'YOUR ACCESS TOKEN'
end

api_instance = BombBomb::EmailsApi.new

begin
  #Get all quicksend templates
  api_instance.get_quick_send_templates
rescue BombBomb::ApiError => e
  puts "Exception when calling EmailsApi->get_quick_send_templates: #{e}"
end

Parameters

This endpoint does not need any parameter.

Return type

nil (empty response body)

Authorization

BBOAuth2

HTTP request headers

Content-Type: application/x-www-form-urlencoded
Accept: application/json

get_template_html_for_template_id

get_template_html_for_template_id(template_id, opts)

Get the HTML for a given template

Get the HTML for a given template, with or without rendered variables

Example

# load the gem
require 'bombbomb'
# setup authorization
BombBomb.configure do |config|
  # Configure OAuth2 access token for authorization: BBOAuth2
  config.access_token = 'YOUR ACCESS TOKEN'
end

api_instance = BombBomb::EmailsApi.new

template_id = "template_id_example" # String | The id of the template.

opts = { 
  render_variables: "render_variables_example" # String | Whether to render profile variables in the returned HTML.
}

begin
  #Get the HTML for a given template
  api_instance.get_template_html_for_template_id(template_id, opts)
rescue BombBomb::ApiError => e
  puts "Exception when calling EmailsApi->get_template_html_for_template_id: #{e}"
end

Parameters

Name	Type	Description	Notes
template_id	String	The id of the template.
render_variables	String	Whether to render profile variables in the returned HTML.	[optional]

Return type

nil (empty response body)

Authorization

BBOAuth2

HTTP request headers

Content-Type: application/x-www-form-urlencoded
Accept: application/json

get_video_quick_sender_data

get_video_quick_sender_data(opts)

Get quicksend data

Get the user data for quicksender, including templates and lists.

Example

# load the gem
require 'bombbomb'
# setup authorization
BombBomb.configure do |config|
  # Configure OAuth2 access token for authorization: BBOAuth2
  config.access_token = 'YOUR ACCESS TOKEN'
end

api_instance = BombBomb::EmailsApi.new

opts = { 
  message: "message_example", # String | A message for the video content.
  subject: "subject_example", # String | A subject for the video content.
  video_id: "video_id_example", # String | A video ID.
  template_id: "template_id_example", # String | A template ID.
  comma_delim_emails: "comma_delim_emails_example" # String | Comma delimited emails
}

begin
  #Get quicksend data
  api_instance.get_video_quick_sender_data(opts)
rescue BombBomb::ApiError => e
  puts "Exception when calling EmailsApi->get_video_quick_sender_data: #{e}"
end

Parameters

Name	Type	Description	Notes
message	String	A message for the video content.	[optional]
subject	String	A subject for the video content.	[optional]
video_id	String	A video ID.	[optional]
template_id	String	A template ID.	[optional]
comma_delim_emails	String	Comma delimited emails	[optional]

Return type

nil (empty response body)

Authorization

BBOAuth2

HTTP request headers

Content-Type: application/x-www-form-urlencoded
Accept: application/json

save_quick_sender_settings

save_quick_sender_settings(opts)

Save quicksender settings

Save the quicksender notification and default template settings

Example

# load the gem
require 'bombbomb'
# setup authorization
BombBomb.configure do |config|
  # Configure OAuth2 access token for authorization: BBOAuth2
  config.access_token = 'YOUR ACCESS TOKEN'
end

api_instance = BombBomb::EmailsApi.new

opts = { 
  alert_on_play: "alert_on_play_example", # String | A preference setting for whether or not to notify user on quicksend email video plays.
  alert_on_open: "alert_on_open_example", # String | A preference setting for whether or not to notify user on quicksend email opens.
  template_id: "template_id_example" # String | Id of a template to use for this send. A null value means use the default for this user.
}

begin
  #Save quicksender settings
  api_instance.save_quick_sender_settings(opts)
rescue BombBomb::ApiError => e
  puts "Exception when calling EmailsApi->save_quick_sender_settings: #{e}"
end

Parameters

Name	Type	Description	Notes
alert_on_play	String	A preference setting for whether or not to notify user on quicksend email video plays.	[optional]
alert_on_open	String	A preference setting for whether or not to notify user on quicksend email opens.	[optional]
template_id	String	Id of a template to use for this send. A null value means use the default for this user.	[optional]

Return type

nil (empty response body)

Authorization

BBOAuth2

HTTP request headers

Content-Type: application/x-www-form-urlencoded
Accept: application/json

video_quick_sender

video_quick_sender(opts)

Send a quicksend email

Send a quicksend video email to the list or users provided.

Example

# load the gem
require 'bombbomb'
# setup authorization
BombBomb.configure do |config|
  # Configure OAuth2 access token for authorization: BBOAuth2
  config.access_token = 'YOUR ACCESS TOKEN'
end

api_instance = BombBomb::EmailsApi.new

opts = { 
  video_id: "video_id_example", # String | A guid id for the video.
  email_addresses: "email_addresses_example", # String | A semi-colon separated list of email addresses to send to.
  subject: "subject_example", # String | Subject line for the email.
  message: "message_example", # String | Message for the body of the email.
  list_ids: "list_ids_example", # String | An array of list ids
  scheduled_send_timestamp: 56, # Integer | When to schedule the send (seconds since epoch). null value means send immediately.
  extended_properties: "extended_properties_example", # String | Bool value that when checked will send back both emailId as well as extra properties
  template_id: "template_id_example", # String | Id of a template to use for this send. A null value means use the default for this user.
  strip_html: "strip_html_example" # String | remove HTML elements
}

begin
  #Send a quicksend email
  api_instance.video_quick_sender(opts)
rescue BombBomb::ApiError => e
  puts "Exception when calling EmailsApi->video_quick_sender: #{e}"
end

Parameters

Name	Type	Description	Notes
video_id	String	A guid id for the video.	[optional]
email_addresses	String	A semi-colon separated list of email addresses to send to.	[optional]
subject	String	Subject line for the email.	[optional]
message	String	Message for the body of the email.	[optional]
list_ids	String	An array of list ids	[optional]
scheduled_send_timestamp	Integer	When to schedule the send (seconds since epoch). null value means send immediately.	[optional]
extended_properties	String	Bool value that when checked will send back both emailId as well as extra properties	[optional]
template_id	String	Id of a template to use for this send. A null value means use the default for this user.	[optional]
strip_html	String	remove HTML elements	[optional]

Return type

nil (empty response body)

Authorization

BBOAuth2

HTTP request headers

Content-Type: application/x-www-form-urlencoded
Accept: application/json

Files

EmailsApi.md

Latest commit

History

EmailsApi.md

File metadata and controls

BombBomb::EmailsApi

create_printing_press_email

Example

Parameters

Return type

Authorization

HTTP request headers

get_all_templates_for_current_user

Example

Parameters

Return type

Authorization

HTTP request headers

get_email_tracking

Example

Parameters

Return type

Authorization

HTTP request headers

get_email_tracking_interactions

Example

Parameters

Return type

Authorization

HTTP request headers

get_hourly_email_tracking

Example

Parameters

Return type

Authorization

HTTP request headers

get_live_fire_data

Example

Parameters

Return type

Authorization

HTTP request headers

get_quick_send_templates

Example

Parameters

Return type

Authorization

HTTP request headers

get_template_html_for_template_id

Example

Parameters

Return type

Authorization

HTTP request headers

get_video_quick_sender_data

Example

Parameters

Return type

Authorization

HTTP request headers

save_quick_sender_settings

Example

Parameters

Return type

Authorization

HTTP request headers

video_quick_sender

Example

Parameters

Return type

Authorization

HTTP request headers