Benchmark Email Email API

OverviewAdvanced Form Integration plugin allows you to integrate Forminator Forms with Benchmark Email. When a user fills a form on your website, the plugin will send the data to your Benchmark Email account and create a Contact. You can add the contact to an email list.2 Sample Contact FormsSupported FeaturesCreate new contact. Add contact to email lists. Custom fields can be added in the AFI Pro version.RequirementsThe feature requires a Pro license. BUY NOW!Make sure that the Pro version of the Advanced Form Integration plugin is installed and activated. You should have got the links in the email after purchase. You can also download it anytime by logging into the user dashboard.Read plugin documentation for Forminator and Benchmark Email. It is not required but helpful for a better understanding.Set up Benchmark Email API ConnectionBefore starting, you are required to set up the Benchmark Email API connection in plugin settings. Go to the WordPress admin area, and click AFI > Settings.Turn on Benchmark and save. Open the Benchmark ta.Go to your Benchmark Email account. Then go to Profile > Integrations > API Key. Copy the API Key.Paste the key in the API Key input box and click Save Changes.Create New IntegrationOnce the API connection is done you can start creating new integration. Click on Add New under AFI menu, New Integration page will appear.TitleA default title will be auto-generated with an auto incremental number. You can rename it to something related to the task. It will help you to quickly recognize the correct one when there is multiple integrations setup.TriggerSelect Forminator in the Form Provider dropdown. Forminator plugin must be installed and activated otherwise you won’t see it listed. After selecting Forminator, all forms built under it will be fetched and auto-populated in the Form/Task Name dropdown. Select the form that you want to integrate.Forminator – Trigger setupActionSelect Benchmark Email in the Platform dropdown.Benchmark Email – ActionMap FieldsMap Fields section will appear where you’ll be able to determine which fields to send. Map Email, First Name, Last Name, etc. fields with a similar field in the sender platform. Finally, click the Save Integration button.Benchmark Email – Map fieldsConditional LogicPlease check the documentation on Conditional Logic.Frequently asked questionsTroubleshootingStill, need help?Reach our support team at [email protected]

Else return message.method listUnsubscribeContactsUnsubscribe the contacts from the given contact list. Parametersstringtoken - Your Benchmark Email TokenstringlistID - The ID of the list you want to add toarray of stringcontacts - The array containing the contact informationReturn ValueintegerReturns the number of contacts left in the list.method listUpdateUpdate the contact list with the given name & descriptionParametersstringtoken - Your Benchmark Email Tokenstringlistid - The ID for the contact liststringlistname - The name for the contact liststringlistdescription - The description for the contact listReturn ValuebooleanReturns true if the update is done.method listUpdateContactDetailsUpdate the given contact in the list based on the details providedParametersstringtoken - Your Benchmark Email TokenstringlistID - The ID of the list you want to fetch the contacts fromstringcontactID - The ID of the contact which you want to editstructcontactDetail - The details of the contactReturn ValuestructReturns the details for the contactmethod ListUpdateContactDetailsByEmailUpdate the given contact in the list based on the details providedParametersstringtoken - Your Benchmark Email TokenstringlistID - The ID of the list you want to fetch the contacts fromstructcontactDetail - The details of the contactReturn ValuestructReturns the details for the contactmethod logAppLog AppParametersstringtoken - Your Benchmark Email TokenstringfilterType - App typeReturn Valuemethod loginAuthenticate the user and returns a token.Parametersstringusername - Your Benchmark Email user namestringpassword - Your Benchmark Email passwordReturn ValuestringReturns the token to be used in subsequent API calls.method logindeviceAuthenticate the user and returns a token.Parametersstringusername - Your Benchmark Email user namestringpassword - Your Benchmark Email passwordstringdevicename - Device used for accessing apiReturn ValuestringReturns the token to be used in subsequent API calls.method permanentTokenGetAuthenticate the user and returns a permanent token.Parametersstringusername - Your Benchmark Email user namestringpassword - Your Benchmark Email passwordReturn Valuestruct BMEAccountStructureReturns the token to be used in subsequent API calls.method planGetListGet PlansParametersstringtoken - Your Benchmark Email TokenReturn Valuearray of struct PlanDetailStructurereturns Plans Infomethod planUpgradeUpgrade to IPhone Premium PlanParametersstringtoken - Your Benchmark Email TokenstringplanToken - Plan TokenReturn Valuemethod pollCopyCopy an existing Poll to new PollParametersstringtoken - Your Benchmark Email TokenstringPollID - ID of the existing pollstringNewPollName - Name of the new PollReturn ValuestringReturns the id of newly created Poll.method pollCreateCreate a new Poll based on the details provided. Return the ID of the newly created Poll.Parametersstringtoken - Your Benchmark Email Tokenstruct PollStructurepoll - The details for the pollReturn ValuestringReturns the ID of the newly created poll.method pollDeleteDelete an existing Poll based on the details provided.Parametersstringtoken - Your Benchmark Email TokenstringPollID - The pollid for the pollReturn ValuestringReturns the ID of the deleted poll.method pollGetDetailGet the poll details.Parametersstringtoken - Your Benchmark Email TokenstringpollID - poll idstringlanguage - languageReturn ValueReturns the poll details.method pollGetListGet the list of Polls using the filter and paging limits, order by the name or date of the polls.Parametersstringtoken - Your Benchmark

You need to see the results. Benchmark shows you standard email stats on open rates, click rates, and unsubscribe rates.A cool reporting feature is the geolocation graph. It breaks down opens by country. If you want to see how each link in an email performs, there is an overview for that called link performance stats. Benchmark also gives you an hourly performance graph and an email heatmap.If you want detailed stats you can integrate with tools like Google Analytics for a deeper performance review.Other useful reports included in the Benchmark dashboard are:Automation reportsA/B test reportsComplain reportsSurvey and poll reportsFor landing pages, you’ll get statistics on:VisitorsConversionsAnd conversion ratesThere is no direct view to get the sign-up numbers available. Those numbers are found by cross-checking the email list that they signed up for.The way these KPIs and stats are presented makes it easy to interpret and act on data. You can export most data into CSV or XLS files for custom data handling.Get started with Benchmark Email for free hereIntegrationsBenchmark does well compared to other email service providers when it comes to integrations. It offers 1500+ integrations to email verification tools, text marketing platforms, CRMs, ecommerce tools, and project management platforms. These include popular integrations like Google, Facebook, Zapier, Shopify, WordPress, Paypal, Zendesk, and more.If you want other applications to access your API key, you’ll find it in your Account > Settings > Integrations>API Key. If there is somehow an integration that isn’t available, reach out to Benchmark and they’ll help you make the connection. Benchmark Customer SupportBenchmark’s customer support is responsive and friendly. They have phone support for the UK, US, and an international hotline.Even with a free plan, Benchmark encourages you to get in touch with them for setup. Reach out through email, live chat, or a call. Support is

TokenstringYTLogin - YouTube LoginstringPageNumber - Page NumberstringPageSize - Page SizeReturn Valuearray of struct YouTubeVideoStructureReturns the list of videosmethod clientNotificationGetListGet the list of notifications messagesParametersstringtoken - Your Benchmark Email Tokenstringstatus - The filter you want to apply when fetching the notificationsstringpageNumber - The page number from which you want the liststringpageSize - The number of results per pageReturn Valuearray of struct NotificationListStructureReturns the list of notification messages.method clientNotificationSetReadSet the notification as readParametersstringtoken - Your Benchmark Email TokenstringMessageID - Message IDReturn Valuemethod clientRatingRangeGet Global Client Rating RangeParametersstringtoken - Your Benchmark Email TokenReturn Valuestruct ClientRatingRangeStructureReturns Global Client Rating Min and Max valuesmethod clientSetContactInfoSet Client InfoParametersstringtoken - Your Benchmark Email Tokenstruct ClientSettingsStructurecltStruct - Client settings structureReturn ValueintegerSets Client settingsmethod clientSetYouTubeInfoSet YouTube Authorization for the accountParametersstringtoken - Your Benchmark Email TokenstringUsername - Login for the YouTube AccountstringPassword - Password for the YouTube AccountReturn ValuebooleanReturns true if the data is savedmethod clientUpdateExtraUpdate Client ExtraParametersstringtoken - Your Benchmark Email TokenstringclientID - The Client IDstringcolname - The Column Namestringcolval - The Column ValueReturn Valuemethod confirmEmailAddAdd emails for ConfirmationParametersstringtoken - Your Benchmark Email TokenstringtargetEmailID - List of emails to be confirmedReturn Valuestringreturns List of Confirmed Emailsmethod confirmEmailListGet Confirmed EmailsParametersstringtoken - Your Benchmark Email TokenReturn Valuearray of struct ConfirmEmailStructurereturns List of Confirmed Emailsmethod contactsGetUniqueActiveCountGet the count of unique active contacts.Parametersstringtoken - Your Benchmark Email TokenReturn ValuedoubleReturns the count of unique active contacts.method contentGetPREMIUM: Get the contentsParametersstringpremiumToken - The Premium TokenstringpageID - The Page IDstringqryString - QuerystringstringdataString - Post DataReturn ValuestringReturns the structure with the details of the email.method CreateListPlan1KAccountSet up an account with a certain plan, etc. for a user who signs up as a partner of a specific partner. Note that this API is not open for all.Parametersstringtoken - Your Benchmark Email Tokenstruct ClientMasterStructureclientstruct - The structure containing the client informationReturn Valuestringreturns Success or Failuremethod emailAssignListAssign contact lists to the emailParametersstringtoken - Your Benchmark Email TokenstringemailID - The email IDarray of struct EmailContactStructurelists - The contact listsReturn Valuemethod emailBadgeUpdateUpdate the email badgeParametersstringtoken - Your Benchmark Email TokenstringemailID - ID for the emailstringbadge - The Badge URLReturn ValuestringReturns status of the updatemethod emailCategoryGetListGet the list of email templates CategoriesParametersstringtoken - Your Benchmark Email TokenReturn Valuearray of struct EmailTemplateCategoryStructureReturns the list of email templates Category.method emailCheckNameCheck the name of an Email to determine if it is taken. Return 1 if it is unique.Parametersstringtoken - Your Benchmark Email TokenstringemailID - The email ID to checkstringemailName - The email name to checkReturn ValueintegerReturns 1 if the name is unique.method emailCopyDuplicate an existing Email and return the ID of the newly created Email. Parametersstringtoken - Your Benchmark Email TokenstringemailID - The Email ID which you want to copyReturn ValuestringReturns the Email ID of the newly created email.method emailCopyAsDuplicate an existing Email and return the

The details provided.Parametersstringtoken - Your Benchmark Email TokenstringsignupFormID - The signup form IDReturn ValuebooleanReturns the Code for the signup form.method signupFormGetGet the details for the signup form based on the ID provided. Parametersstringtoken - Your Benchmark Email TokenstringsignupFormID - The details for the emailReturn Valuestruct SignupFormDataStructureReturns the structure of the given signup form ID.method signupFormGetCodeGet the code for the signup form based on the details provided.Parametersstringtoken - Your Benchmark Email TokenstringsignupFormID - The signup form IDstringcodeType - Type of CodeReturn ValuestringReturns the Code for the signup form.method signupFormUpdateUpdate the new signup form based on the details provided. Return the true if the changes were commited.Parametersstringtoken - Your Benchmark Email TokenstringsignupFormID - Your Signup Form IDstruct SignupFormDataStructuresignupForm - The details for the emailReturn ValuebooleanReturns true if the changes were saved to the signup form.method signupFormUpdateColorUpdate the colors in the signup form based on the details provided. Return the true if the changes were commited.Parametersstringtoken - Your Benchmark Email TokenstringsignupFormID - Your Signup Form IDstruct SignupFormColorStructuresignupForm - The details for the signup formReturn ValuebooleanReturns true if the changes were saved to the signup form.method signupFormUpdateMessageUpdate the signup form's from email and welcome message based on the details provided. Return the true if the changes were commited.Parametersstringtoken - Your Benchmark Email TokenstringsignupFormID - Your Signup Form IDstruct SignupFormDataStructuresignupForm - The details for the emailReturn ValuebooleanReturns true if the changes were saved to the signup form.method subAccountCreateRegister a new SubAccountParametersstringtoken - Your Benchmark Email Tokenstruct AccountStructureaccountstruct - The structure containing the client account informationReturn ValueintegerReturns 1 if the register action was successful and -1 if it was notmethod subAccountGetGet the details of SubAccountParametersstringtoken - Your Benchmark Email Tokenstringdata - details to search forReturn ValueReturns the details of SubAccount.method subAccountGetBalanceUpdate SubAccount detailsParametersstringtoken - Your Benchmark Email TokenstringchildClientID - The structure containing the client account informationReturn ValueReturns errorlist if the update SubAccount action was successful and -1 if it was notmethod subAccountGetListGet the list of SubAccountsParametersstringtoken - Your Benchmark Email TokenReturn Valuearray of struct AccountStructureReturns the list of SubAccounts.method subAccountGetTokenAuthenticate the user and returns a token for sub account.Parametersstringtoken - Your Benchmark Email user namestringsubAccountID - Your Benchmark Email passwordReturn ValuestringReturns the token to be used in subsequent API calls.method subAccountListGet SubAccountsParametersstringtoken - Your Benchmark Email Tokenstringdata - details to search forReturn ValueReturns list of subaccountsmethod subAccountUpdateUpdate SubAccount detailsParametersstringtoken - Your Benchmark Email Tokenstruct AccountStructureaccountstruct - The structure containing the client account informationReturn ValueintegerReturns 1 if the update SubAccount action was successful and -1 if it was notmethod subAccountUpdateDetailUpdate SubAccount detailsParametersstringtoken - Your Benchmark Email Tokenstringdata - The structure containing the client account informationReturn ValueReturns errorlist if the update SubAccount action was successful and -1 if it was notmethod subAccountUpdateStatusUpdate SubAccount statusParametersstringtoken - Your Benchmark Email