BombBomb::PromptsApi

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

Method	HTTP request	Description
create_prompt_bot	POST /prompts/bots	Create a running Prompt Bot for a list
create_video_email_prompt	POST /prompt	Prompts user to send a video
get_alternate_campaign_content	GET /campaign/{campaignId}/content/alternate	List alternate campaign content
get_pending_video_email_prompts	GET /prompt/pending	List pending prompts
get_prompt_bots	GET /prompts/bots	List Prompt Bots
get_prompt_campaigns	GET /prompts/{userId}/campaigns	List Prompt Campaigns
get_video_email_prompt	GET /prompt/{id}	Gets a prompt
get_video_email_prompts	GET /prompt/	List prompts
respond_to_video_email_prompt	POST /prompt/{id}/response	Respond to a prompt
send_prompt_immediately	POST /prompt/{id}/sendit
sync_prompt_subscriptions	POST /prompts/campaigns/sync	Syncs Campaigns and One to Ones Subscriptions for User
update_prompt	PUT /prompts/{id}	Update Prompt
update_prompt_bot	PUT /prompts/bots/{id}	Update Prompt Bot
update_prompt_campaign	PUT /prompts/campaigns/{clientGroupId}	Update Prompt Campaign
update_prompt_template	PUT /prompts/{id}/content	Update Prompt Content

create_prompt_bot

PromptBot create_prompt_bot(email_id, name, subject, content, contact_field_value_column, bot_type_id, template_id, opts)

Create a running Prompt Bot for a list

Creates a Prompt Bot that sends emails to contacts on a list over the span of time defined.

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::PromptsApi.new

email_id = "email_id_example" # String | The default email to use.

name = "name_example" # String | The name of the bot.

subject = "subject_example" # String | The subject of the default email.

content = "content_example" # String | The content used in the email.

contact_field_value_column = "contact_field_value_column_example" # String | The custom field value column with dates for this bot.

bot_type_id = "bot_type_id_example" # String | The type of bot to create.

template_id = "template_id_example" # String | The template used to create the email id.

opts = { 
  list_id: "list_id_example", # String | The list id to attach the bot to.
  video_id: "video_id_example", # String | The video used in the email.
  end_date: "end_date_example" # String | The time frame to complete sending to the list.
}

begin
  #Create a running Prompt Bot for a list
  result = api_instance.create_prompt_bot(email_id, name, subject, content, contact_field_value_column, bot_type_id, template_id, opts)
  p result
rescue BombBomb::ApiError => e
  puts "Exception when calling PromptsApi->create_prompt_bot: #{e}"
end

Parameters

Name	Type	Description	Notes
email_id	String	The default email to use.
name	String	The name of the bot.
subject	String	The subject of the default email.
content	String	The content used in the email.
contact_field_value_column	String	The custom field value column with dates for this bot.
bot_type_id	String	The type of bot to create.
template_id	String	The template used to create the email id.
list_id	String	The list id to attach the bot to.	[optional]
video_id	String	The video used in the email.	[optional]
end_date	String	The time frame to complete sending to the list.	[optional]

Return type

PromptBot

Authorization

BBOAuth2

HTTP request headers

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

create_video_email_prompt

VideoEmailPrompt create_video_email_prompt(prompt)

Prompts user to send a video

Sends the account holder an email prompting them to add a video to a scheduled outgoing message. Recipients, content and timing is all preset for 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::PromptsApi.new

prompt = BombBomb::VideoEmailPrompt.new # VideoEmailPrompt | The Video Email Prompt to be created


begin
  #Prompts user to send a video
  result = api_instance.create_video_email_prompt(prompt)
  p result
rescue BombBomb::ApiError => e
  puts "Exception when calling PromptsApi->create_video_email_prompt: #{e}"
end

Parameters

Name	Type	Description	Notes
prompt	VideoEmailPrompt	The Video Email Prompt to be created

Return type

VideoEmailPrompt

Authorization

BBOAuth2

HTTP request headers

Content-Type: application/json
Accept: application/json

get_alternate_campaign_content

get_alternate_campaign_content(client_group_id)

List alternate campaign content

Returns a list of alternate campaign content by campaign id

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::PromptsApi.new

client_group_id = "client_group_id_example" # String | Id for the campaign


begin
  #List alternate campaign content
  api_instance.get_alternate_campaign_content(client_group_id)
rescue BombBomb::ApiError => e
  puts "Exception when calling PromptsApi->get_alternate_campaign_content: #{e}"
end

Parameters

Name	Type	Description	Notes
client_group_id	String	Id for the campaign

Return type

nil (empty response body)

Authorization

BBOAuth2

HTTP request headers

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

get_pending_video_email_prompts

Array<VideoEmailPrompt> get_pending_video_email_prompts

List pending prompts

Returns a list of prompts that have not been sent yet, and can still be customized.

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::PromptsApi.new

begin
  #List pending prompts
  result = api_instance.get_pending_video_email_prompts
  p result
rescue BombBomb::ApiError => e
  puts "Exception when calling PromptsApi->get_pending_video_email_prompts: #{e}"
end

Parameters

This endpoint does not need any parameter.

Return type

Array<VideoEmailPrompt>

Authorization

BBOAuth2

HTTP request headers

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

get_prompt_bots

Array<PromptBot> get_prompt_bots

List Prompt Bots

Returns a list of all Prompt Bots for 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::PromptsApi.new

begin
  #List Prompt Bots
  result = api_instance.get_prompt_bots
  p result
rescue BombBomb::ApiError => e
  puts "Exception when calling PromptsApi->get_prompt_bots: #{e}"
end

Parameters

This endpoint does not need any parameter.

Return type

Array<PromptBot>

Authorization

BBOAuth2

HTTP request headers

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

get_prompt_campaigns

get_prompt_campaigns

List Prompt Campaigns

Returns a list of all Prompt Campaigns for 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::PromptsApi.new

begin
  #List Prompt Campaigns
  api_instance.get_prompt_campaigns
rescue BombBomb::ApiError => e
  puts "Exception when calling PromptsApi->get_prompt_campaigns: #{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_video_email_prompt

VideoEmailPrompt get_video_email_prompt(id)

Gets a prompt

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::PromptsApi.new

id = "id_example" # String | The Id of the prompt


begin
  #Gets a prompt
  result = api_instance.get_video_email_prompt(id)
  p result
rescue BombBomb::ApiError => e
  puts "Exception when calling PromptsApi->get_video_email_prompt: #{e}"
end

Parameters

Name	Type	Description	Notes
id	String	The Id of the prompt

Return type

VideoEmailPrompt

Authorization

BBOAuth2

HTTP request headers

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

get_video_email_prompts

Array<VideoEmailPrompt> get_video_email_prompts

List prompts

Returns a list of all prompts.

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::PromptsApi.new

begin
  #List prompts
  result = api_instance.get_video_email_prompts
  p result
rescue BombBomb::ApiError => e
  puts "Exception when calling PromptsApi->get_video_email_prompts: #{e}"
end

Parameters

This endpoint does not need any parameter.

Return type

Array<VideoEmailPrompt>

Authorization

BBOAuth2

HTTP request headers

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

respond_to_video_email_prompt

VideoEmailPrompt respond_to_video_email_prompt(id, choice, opts)

Respond to a prompt

Respond to a prompt by either adding a video, sending without a video or cancelling the prompt.

Example

# load the gem
require 'bombbomb'

api_instance = BombBomb::PromptsApi.new

id = "id_example" # String | The id of the prompt.

choice = "choice_example" # String | The users' selection. Can be: WithVideo, WithEmail, Cancel, Restore, Reset, Manual

opts = { 
  video_id: "video_id_example", # String | The id of the video.
  email_id: "email_id_example", # String | The id of the email.
  subject: "subject_example" # String | The subject of the email
}

begin
  #Respond to a prompt
  result = api_instance.respond_to_video_email_prompt(id, choice, opts)
  p result
rescue BombBomb::ApiError => e
  puts "Exception when calling PromptsApi->respond_to_video_email_prompt: #{e}"
end

Parameters

Name	Type	Description	Notes
id	String	The id of the prompt.
choice	String	The users' selection. Can be: WithVideo, WithEmail, Cancel, Restore, Reset, Manual
video_id	String	The id of the video.	[optional]
email_id	String	The id of the email.	[optional]
subject	String	The subject of the email	[optional]

Return type

VideoEmailPrompt

Authorization

No authorization required

HTTP request headers

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

send_prompt_immediately

send_prompt_immediately(id)

Ignore send date and send the prompt now.

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::PromptsApi.new

id = "id_example" # String | The Id of the prompt


begin
  #
  api_instance.send_prompt_immediately(id)
rescue BombBomb::ApiError => e
  puts "Exception when calling PromptsApi->send_prompt_immediately: #{e}"
end

Parameters

Name	Type	Description	Notes
id	String	The Id of the prompt

Return type

nil (empty response body)

Authorization

BBOAuth2

HTTP request headers

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

sync_prompt_subscriptions

sync_prompt_subscriptions(opts)

Syncs Campaigns and One to Ones Subscriptions for User

Syncs Campaigns and One to Ones Subscriptions for User based on their profile information. The user must be a Prompt Subscriber.

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::PromptsApi.new

opts = { 
  migrate: true # BOOLEAN | After syncing, migrate away from old campaigns.
}

begin
  #Syncs Campaigns and One to Ones Subscriptions for User
  api_instance.sync_prompt_subscriptions(opts)
rescue BombBomb::ApiError => e
  puts "Exception when calling PromptsApi->sync_prompt_subscriptions: #{e}"
end

Parameters

Name	Type	Description	Notes
migrate	BOOLEAN	After syncing, migrate away from old campaigns.	[optional]

Return type

nil (empty response body)

Authorization

BBOAuth2

HTTP request headers

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

update_prompt

update_prompt(id, opts)

Update Prompt

Updates a Prompt

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::PromptsApi.new

id = "id_example" # String | The prompt's id

opts = { 
  send_mechanism: "send_mechanism_example", # String | The mechanism for the prompt to be sent
  facebook_message: "facebook_message_example", # String | The facebook message assigned to the prompt
  twitter_message: "twitter_message_example", # String | The twitter message assigned to the prompt
  video_id: "video_id_example", # String | The id of the video.
  email_id: "email_id_example", # String | The id of the email.
  subject: "subject_example", # String | The subject of the email
  reset_cache: "reset_cache_example", # String | The subject of the email
  reset_email_content: "reset_email_content_example", # String | The subject of the email
  status: "status_example" # String | The status of the prompt
}

begin
  #Update Prompt
  api_instance.update_prompt(id, opts)
rescue BombBomb::ApiError => e
  puts "Exception when calling PromptsApi->update_prompt: #{e}"
end

Parameters

Name	Type	Description	Notes
id	String	The prompt's id
send_mechanism	String	The mechanism for the prompt to be sent	[optional]
facebook_message	String	The facebook message assigned to the prompt	[optional]
twitter_message	String	The twitter message assigned to the prompt	[optional]
video_id	String	The id of the video.	[optional]
email_id	String	The id of the email.	[optional]
subject	String	The subject of the email	[optional]
reset_cache	String	The subject of the email	[optional]
reset_email_content	String	The subject of the email	[optional]
status	String	The status of the prompt	[optional]

Return type

nil (empty response body)

Authorization

BBOAuth2

HTTP request headers

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

update_prompt_bot

PromptBot update_prompt_bot(id, email_id, name, subject, content, contact_field_value_column, template_id, opts)

Update Prompt Bot

Updates a Prompt Bot's 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::PromptsApi.new

id = "id_example" # String | The bot id.

email_id = "email_id_example" # String | The default email to use.

name = "name_example" # String | The name of the bot.

subject = "subject_example" # String | The subject of the default email.

content = "content_example" # String | The content used in the default email.

contact_field_value_column = "contact_field_value_column_example" # String | The custom field value column with dates for this bot.

template_id = "template_id_example" # String | The template used to create the email id.

opts = { 
  list_id: "list_id_example", # String | The list id to attach the bot to.
  video_id: "video_id_example", # String | The video used in the default email.
  end_date: "end_date_example", # String | The time frame to complete sending to the list.
  status: "status_example" # String | The status of the bot.
}

begin
  #Update Prompt Bot
  result = api_instance.update_prompt_bot(id, email_id, name, subject, content, contact_field_value_column, template_id, opts)
  p result
rescue BombBomb::ApiError => e
  puts "Exception when calling PromptsApi->update_prompt_bot: #{e}"
end

Parameters

Name	Type	Description	Notes
id	String	The bot id.
email_id	String	The default email to use.
name	String	The name of the bot.
subject	String	The subject of the default email.
content	String	The content used in the default email.
contact_field_value_column	String	The custom field value column with dates for this bot.
template_id	String	The template used to create the email id.
list_id	String	The list id to attach the bot to.	[optional]
video_id	String	The video used in the default email.	[optional]
end_date	String	The time frame to complete sending to the list.	[optional]
status	String	The status of the bot.	[optional]

Return type

PromptBot

Authorization

BBOAuth2

HTTP request headers

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

update_prompt_campaign

update_prompt_campaign(client_group_id, opts)

Update Prompt Campaign

Updates a Prompt Campaign's 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::PromptsApi.new

client_group_id = "client_group_id_example" # String | The client group of the campaign.

opts = { 
  branded_template_id: "branded_template_id_example", # String | The template to use for branded feel emails.
  personal_template_id: "personal_template_id_example", # String | The template to use for personal feel emails.
  enabled: true, # BOOLEAN | Set whether the user is able to start receiving prompts.
  send_mechanism: "send_mechanism_example" # String | The way to send the prompt
}

begin
  #Update Prompt Campaign
  api_instance.update_prompt_campaign(client_group_id, opts)
rescue BombBomb::ApiError => e
  puts "Exception when calling PromptsApi->update_prompt_campaign: #{e}"
end

Parameters

Name	Type	Description	Notes
client_group_id	String	The client group of the campaign.
branded_template_id	String	The template to use for branded feel emails.	[optional]
personal_template_id	String	The template to use for personal feel emails.	[optional]
enabled	BOOLEAN	Set whether the user is able to start receiving prompts.	[optional]
send_mechanism	String	The way to send the prompt	[optional]

Return type

nil (empty response body)

Authorization

BBOAuth2

HTTP request headers

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

update_prompt_template

update_prompt_template(id, alternate_content_id, new_email_id, og_email_id, new_example_video_id)

Update Prompt Content

Updates a Prompt Content

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::PromptsApi.new

id = "id_example" # String | The prompt's id

alternate_content_id = "alternate_content_id_example" # String | The alternate content id

new_email_id = "new_email_id_example" # String | The prompt's new email id

og_email_id = "og_email_id_example" # String | The prompt's original email id

new_example_video_id = "new_example_video_id_example" # String | The prompt's new tutorial video id


begin
  #Update Prompt Content
  api_instance.update_prompt_template(id, alternate_content_id, new_email_id, og_email_id, new_example_video_id)
rescue BombBomb::ApiError => e
  puts "Exception when calling PromptsApi->update_prompt_template: #{e}"
end

Parameters

Name	Type	Description
id	String	The prompt's id
alternate_content_id	String	The alternate content id
new_email_id	String	The prompt's new email id
og_email_id	String	The prompt's original email id
new_example_video_id	String	The prompt's new tutorial video id

Return type

nil (empty response body)

Authorization

BBOAuth2

HTTP request headers

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

Files

PromptsApi.md

Latest commit

History

PromptsApi.md

File metadata and controls

BombBomb::PromptsApi

create_prompt_bot

Example

Parameters

Return type

Authorization

HTTP request headers

create_video_email_prompt

Example

Parameters

Return type

Authorization

HTTP request headers

get_alternate_campaign_content

Example

Parameters

Return type

Authorization

HTTP request headers

get_pending_video_email_prompts

Example

Parameters

Return type

Authorization

HTTP request headers

get_prompt_bots

Example

Parameters

Return type

Authorization

HTTP request headers

get_prompt_campaigns

Example

Parameters

Return type

Authorization

HTTP request headers

get_video_email_prompt

Example

Parameters

Return type

Authorization

HTTP request headers

get_video_email_prompts

Example

Parameters

Return type

Authorization

HTTP request headers

respond_to_video_email_prompt

Example

Parameters

Return type

Authorization

HTTP request headers

send_prompt_immediately

Example

Parameters

Return type

Authorization

HTTP request headers

sync_prompt_subscriptions

Example

Parameters

Return type

Authorization

HTTP request headers

update_prompt

Example

Parameters

Return type

Authorization

HTTP request headers

update_prompt_bot