Overview
Settings and Navigation
In Control Panel > API Keys, keys my be created to be used with our open API.
Configuration Options
These keys have various settings which may be configured: How the key will function, and what channel and campaign to set for it.
Application - name your key something descriptive, especially if you'll have more than one in your account. This makes it easier to differentiate between the keys, and this will show on the Contact Details page as well as the Contact Grid.
Merge Duplicates - this will merge any duplicate contacts that come in through lead capture.
Fields - this determines which fields would need to match for the duplicates (i.e. just names that match, or name/email/phone.)
Branding Scope - branding scope will have this key available throughout the brand. When this is enabled, you won't see the entire key or be able to edit it outside of the primary account where it was created.
Lead Distribution - we'll use the zip/postal code to distribute the new lead to the correct organization.
Dispatch Callback Campaign - puts the contact into a callback campaign in dispatch.
Lead Notification - this sends out lead notification emails. When testing, it's best to turn this off, temporarily.
Default Lead Source - here a Channel and Campaign may be set to automatically be captured when leads come in through this key. Set up these options in Campaigns. Note: this can be overridden by a different Channel/Campaign being assigned on the other end where the lead is submitted/created. If those fields are empty coming from a form or other application, then the default set here will be applied.
Call Center Provider - if using something like AnswerConnect or Perceptionist to answer calls, add that company here in the "Edit API Key" settings.
FAQs
Are API Keys free of charge?
Yes. Free.
