active_campaigns()

Get all active campaigns

add_campaign(string name, integer customer_area_id, integer transport_id, string rules, string send, string per_schedule, string periodic_schedule, string max_per_hour, string status)

Add a new mass campaign

add_list(string name, string customer_type, string user_type, string ignore_opt_out)

Add a new mass mail list

assign_list(integer list_id, integer campaign_id)

Add a new e-mail list to a campaign

campaign_unique(integer user_id, integer campaign_id)

Set the campaign as queued

compile_list(string product_specific, string customer_type, string user_type, string ignore_opt_out, array products_filter, array opt_out, integer list_id, integer campaign_id, string rules)

Send mass mail!

delete_campaign(integer id)

Delete a mass e-mail campaign

delete_list(integer id)

Delete a mass e-mail list

filter_by(integer list_id, integer sku_id)

Add product sku filter to a list

filtered_products(integer list_id)

Get a list of all filtered products for the e-mail list

get_all_campaigns_wp(string sort, array link_extras)

Get a list of all e-mail campaigns with pagination

get_all_email_lists_wp(string sort, array link_extras)

Get a list of all e-mail lists with pagination

get_all_lists(string sort, array link_extras)

Get a list of all e-mail lists with pagination

get_assigned_lists(integer campaign_id, boolean full_record_set)

Get a list of all assigned e-mail lists to the campaign

get_campaign(integer id)

Get campaign data

get_campaign_by_token(string token)

Get campaign data

get_list(integer id)

Get list data

get_lists(integer campaign_id, boolean full_record_set)

Get a list of all assigned e-mail lists to the campaign

get_opt_out()

Get all users who have opt-out

is_campaign_complete(integer campaign_id)

Is the campaign complete?

is_campaign_queued(integer campaign_id, string status)

Get all queued campaigns

opt_out(string email)

Opt-out the user

queued_campaigns()

Get all queued campaigns

remove_filter(integer list_id, integer sku_id)

Remove product sku filter from a list

remove_list(integer list_id, integer campaign_id)

Remove a list from a campaign

save_campaign(string id, string name, integer customer_area_id, integer transport_id, string rules, string send, string per_schedule, string per_schedule_time, string periodic_schedule, string periodic_schedule_time, string max_per_hour, string status)

Save new mass campaign advanced settings

save_campaign_copy(integer id, string subject, string message, string alt_body_message)

Save the e-mail copy

save_list(integer id, string name, string product_specific, string customer_type, string user_type, string ignore_opt_out)

Save changes to an existing list

send(integer customer_area_id, integer transport_id, string subject, string message, string alt_body_message, string valid_tags, string tag_values)

Send mass mail!

send_campaign(integer campaign_id, integer max_per_hour)

Get all messages ready to be sent from the log

send_test(array session, array campaign, string valid_tags)

Send mass mail campaign test

set_queued(integer campaign_id)

Set the campaign as queued

total_recipients(array campaign)

Get the total recipients

total_recipients_enqueue(integer campaign_id)

Get the total recipients based on the queue

write_complete(integer campaign_id)

Mark the campaign as complete

write_last_run(integer campaign_id)

Set the campaign last run date

write_last_run_queued(integer campaign_id)

Set the campaign last run date

write_to_queue(integer customer_area_id, integer customer_id, integer user_id, integer campaign_id, integer list_id, string first_name, string last_name, string email)

Write the mass mail queue

write_to_queue_complete(integer customer_id, integer user_id, integer campaign_id, integer list_id, string email)

Set a queue entry to complete