Admin Guide
Documentation Links
Hunter.io Subscription
You will require a Hunter.io subscription in order for this customisation to work. There are a variety of plans available including a free plan. Pricing starts as low as £0 for a free plan where you can verify up to 50 email addresses per month. Ideal if you don't add that many new contacts.
Hunter.io Subscription API Key Validation
Navigate to Hunter.io and log in or click on the Sign up button to register your account if you don’t already have one. If you're not sure which Hunter subscription plan is suitable for you, then check our FAQ page.
Retrieve your Hunter.io API Key
Once registered and logged into Hunter.io, navigate to your account (top right) > click on ‘API’ > Copy the API Key.
Save your API Key into Sugar
In Sugar, navigate to: Admin > Sugashop™ by Sugabyte - Hunter Email Verifier for SugarCRM > Hunter Email Verifier Settings.
Note: If you don’t see this page, try a full browser refresh.
Paste your API key into the box provided and click on Save.
To retrieve your Hunter API key and update your Sugar instance, follow these steps:
Setting up the Hunter fields in Studio
This customisation will automatically create some new fields in the Accounts, Contacts, Leads and Targets module. They are added to the database and are available in Studio, but they are not automatically added to the layout. Note: All Hunter fields are editable for all users by default. If you wish to restrict user access to these fields, you can do this by using Sugars’ Role Management. Please follow SugarCRMs’ official guide on role management.
New Fields
Field Name | Field Label | Description |
---|---|---|
hunter_status_c | Hunter Status | This dropdown field will display the current status of an Account/Contact/Lead/Target that has been verified. |
hunter_last_checked_c | Hunter Last Checked | This Date/Time field will display the last time an attempt has been made to verify the email address. |
hunter_last_api_details_c | Hunter Report | This field will display the results of various web locations the email has been detected by the Hunter verification service. |
hunter_last_api_c | Hunter Last API Call | This is a TextArea field which displays the complete API response from the Hunter service. This field is useful for power users or system administrators to report on key words returned from Hunter. |
hunter_last_user_c | Hunter Last User | This TextField displays the username of the last Sugar user who performed the most recent email verification. |
hunter_set_scheduler_c | Hunter Add to Scheduler | This checkbox is used when wanting to leverage the Scheduled Job to perform mass email verifications at once. |
Configure the layouts in Studio
We are assuming that you are familiar with the Studio tool in Sugar to configure the layouts. We would advise that you create a separate panel or tab for the Record View in each of the modules that you want to use this tool with.
In order for the Hunter Verifier to work as expected, the fields “Hunter Status” and “Hunter Last Checked” must be added to the Record View Layouts.
Create the Scheduler
You'll need to create a scheduled job in order for mass-updated records to be processed in the background. This is ideal for marking multiple records to be verified instead of verifying each one manually.
To set up the scheduler record, follow these steps: