Overview

The API Settings tab allows the Admin to apply specific API-related settings to the whole Account. The settings on this page will override the parameters within related API Requests.

Contents

• Global Settings
• API Settings Tab
  • Lead Duplication Settings
    • Filter Duplicates Against
    • When Duplicates are Found
    • Target Inactive List
  • Reject Selected Carrier Types
  • API Duplicate Lead Check

To learn more about the Global Settings tab, see Configuring Global Settings.

To learn more about the Notification Settings tab, see In-App System Notifications.

Global Settings

1.) Click the Account main menu.

2.) Click the Global Settings menu option.

The Global Settings page will open on the Global Settings tab.

3.) Click the API Settings tab.

4.) Configure the API Settings as needed.

API Settings Tab

This tab opens with only three (3) fields visible. Certain selections in these settings open more settings. Every settings available on this page are shown below, options in the yellow boxes are the options which open additional settings. 

• Lead Duplication Settings:
  

  • Use API Parameters: 
    When selected, lead deduplication is handled per the parameters passed via the Insert Lead API payload.
  • Always Reject Duplicates: 
    When selected, Duplicate Leads will be rejected upon insertion, regardless of whether the parameter is not passed for APIs. 
    • This setting functions like the check_dup parameter when the value is 1 when inserting Leads via API. 
      • See Insert Leads via API for more information about these API parameters.
  • Always Relocate Duplicates: 
    New Lead inserted via API will be allowed but system will perform real-time deduplication according to preferences below and any duplicate Lead records found for that phone number will be moved to a list named SYS_DUPLICATE_LEADS. 
    Note: This may have implications on the number of dialable Lead records remaining post de-duplication.

    • Filter Duplicates Against:

      • This field opens when Always Relocate Duplicates is selected in the Lead Duplication Settings field.
        This determines the scope in which duplicate Lead records are identified with the same phone number as the new Lead record being inserted via API. 
        • Options available:
          • Entire Account: Check across all Campaigns in the account.
          • Campaign Only: Check within inserted Lead record’s Campaign.
          • List Only: Check within selected List(s).
            • If no List is selected, the check is performed within the new Lead’s List. 
              • A Lists field will open when this option is selected for adding additional Lists to filter duplicates against.
                • The List for newly inserted Lead is used by the system for checking duplicates at all times.
                  
          • Campaign Purpose: Check within all Campaigns having same purpose as the inserted Lead record’s Campaign.

    • When Duplicates are Found:

      • This field opens when Always Relocate Duplicates is selected in the Lead Duplication Settings field.
        
        • Retain new lead: New Lead inserted via API is retained while moving all duplicate Lead records for that same phone number found to SYS_DUPLICATE_LEADS list.
        • Retain new lead and Inbound: New lead inserted via API is retained as well as any corresponding lead record found with ‘Inbound’ as Lead Source with that Lead’s phone number. All other duplicate Lead records found will be moved to SYS_DUPLICATE_LEADS list.

    • Target Inactive List:

      • This field opens when Always Relocate Duplicates is selected in the Lead Duplication Settings field.
        This field is not editable. 
        • This is a system created list to hold duplicate Lead records. Duplicated Leads will be automatically moved to this inactive List.

• Reject Selected Carrier Types:

  • When a carrier type is selected, Leads with that Carrier Type will be rejected upon upload or insertion. 
    • Available options: Mobile, VoIP, Landline. 
      • You can select a maximum of two (2) options.

• API Duplicate Lead Check:

  • When set to Yes, this setting will check for duplicate Leads in third-party CRMs designated by the Admin. To learn more, see API Duplicate Lead Check for Third Party CRM.
    
    • Two (2) fields open when this toggle is set to Yes:
      • Convoso Connect
        Select a Convoso Connect from the drop-down.
      • External API Data Validation
        Clicking the Add button will create a row in the table below.
        • In that row select or enter the relevant criteria for your API:
          • Key: Text field.
          • Value: Text field.
          • Create Lead: Yes/No toggle. If set to No, the Status field becomes inactive. 
          • Status: A drop-down containing available Status/Dispositions. 
          • Add to DNC: Yes/No toggle
          • Success: Yes/No toggle.
          • Action: Remove button, will delete the entry.

5.) Click the Apply Changes button.

Please sign in and vote to let us know if you found this article helpful!

👇