Benchmark Email

MarketingAPI key

Manage Benchmark Email contact lists and contacts, and read, test, schedule and report on email campaigns.

13 actions

Action	Effect	Data handled
benchmark_email_list_contact_listsLists contact lists with their ids and contact counts, optionally filtered by name	read	General
benchmark_email_get_contact_listReturns a contact list's details and field names	read	General
benchmark_email_create_contact_listCreates a contact list and returns its id	write	General
benchmark_email_list_contactsLists or searches the contacts in a list by a field, optionally only unsubscribed or hard-bounced ones	read	Personal data
benchmark_email_search_contactsFinds an email address across all lists and shows each list it is on and its status there	read	Personal data
benchmark_email_get_contactReturns a contact's field values and rating in a list	read	Personal data
benchmark_email_add_contactAdds a contact to a list	write	Personal data
benchmark_email_update_contactUpdates a contact's email or name in a list	write	Personal data
benchmark_email_list_emailsLists email campaigns with their status and dates, optionally filtered by name or status	read	General
benchmark_email_get_emailReturns an email campaign's subject, sender, lists, content and schedule	read	Personal data
benchmark_email_get_email_reportReturns a sent campaign's summary report: opens, clicks, bounces, unsubscribes and more	read	General
benchmark_email_send_test_emailSends a test copy of an email campaign to the given addresses	write	Personal data
benchmark_email_schedule_emailSchedules an email campaign to send at a date and time in a given time zone	write	General

Sign-in

Also included

dexby.createSession({
  userId: customer.id,
  connectors: ['benchmark_email']
})