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
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
Initially, only a handful of settings are visible on the API Settings tab.
- Lead Duplication Settings
- Reject Selected Carrier Types
- Call Recording URL Expiration (minutes)
- API Duplicate Lead Check
| Lead Duplication Settings | Determines how duplicate Lead records are handled when Leads are inserted through the API. |
|---|---|
| Reject Selected Carrier Types |
Prevents Leads associated with selected Carrier Types from being uploaded or inserted.
|
| Call Recording URL Expiration (minutes) |
Defines the expiration time, in minutes, for publicly shared call-recording URLs generated from Leads, Users, and Call Logs APIs.
|
| API Duplicate Lead Check | Enables duplicate Lead checking against third-party CRMs designated by the Admin. |
The Lead Duplication Settings and API Duplicate Lead Check settings open additional settings when certain options are selected. Read below for associated settings.
Lead Duplication Settings
| Field | Description | Options / Conditional Behavior |
|---|---|---|
| Lead Duplication Settings | Determines how Convoso handles duplicate Lead records when Leads are inserted through the API. |
Use API Parameters: Deduplication is handled according to the parameters passed in the Insert Lead API payload. Always Reject Duplicates: Duplicate Leads are rejected upon insertion regardless of whether a duplicate-check parameter is passed through the API. This functions like the Always Relocate Duplicates: The new Lead is allowed to be inserted, and Convoso performs real-time deduplication based on the settings below. Duplicate records with the same phone number are moved to the SYS_DUPLICATE_LEADS inactive List. This may reduce the number of dialable Lead records remaining after deduplication. |
Filter Duplicates Against |
Determines the scope Convoso searches for existing Lead records with the same phone number as the new Lead being inserted through the API. |
Appears when Lead Duplication Settings = Always Relocate Duplicates. Entire Account: Checks across all Campaigns in the account. Campaign Only: Checks within the newly inserted Lead's Campaign. List Only: Checks the selected List(s). If no additional List is selected, Convoso checks the new Lead's List. Campaign Purpose: Checks Campaigns that have the same Campaign Purpose as the newly inserted Lead's Campaign. |
Lists |
Allows additional Lists to be included when checking for duplicate Lead records. The List containing the newly inserted Lead is always included in the duplicate check. |
Appears when Filter Duplicates Against = List Only. If no additional Lists are selected, duplicate checking is performed against the newly inserted Lead's List. |
When Duplicates are Found |
Determines which Lead records remain available for dialing when duplicates with the same phone number are found. Other duplicate records are moved to SYS_DUPLICATE_LEADS. |
Appears when Lead Duplication Settings = Always Relocate Duplicates. Retain new lead: Retains the newly inserted Lead and moves all other duplicate Lead records with the same phone number to SYS_DUPLICATE_LEADS. Retain new lead and Inbound: Retains the newly inserted Lead as well as corresponding records with Inbound as the Lead Source. All other duplicates with the same phone number are moved to SYS_DUPLICATE_LEADS. |
Target Inactive List |
Identifies the system-created inactive List where duplicate Lead records are automatically moved. |
Appears when Lead Duplication Settings = Always Relocate Duplicates. This field is not editable. The target List is SYS_DUPLICATE_LEADS. |
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.
| Field | Description | Options / Conditional Behavior |
|---|---|---|
| API Duplicate Lead Check | Enables duplicate Lead checking against third-party CRMs designated by the Admin. | When set to Yes/On, the Convoso Connect and External API Data Validation fields become available. |
Convoso Connect |
Specifies the Convoso Connect configuration used to connect to the designated third-party CRM for duplicate checking. | Appears when API Duplicate Lead Check = Yes/On. Select a Convoso Connect from the drop-down. |
External API Data Validation |
Defines how responses from the external API are evaluated and what Convoso should do based on the returned criteria. Clicking Add creates a new validation row. | Appears when API Duplicate Lead Check = Yes/On. Each row contains Key, Value, Create Lead, Status, Add to DNC, Success, and Action. |
External API Data Validation
Clicking the Add button will create a row in the table below.
| Key | Defines the API response key used as part of the external data-validation criteria. | Text field within an External API Data Validation row. |
|---|---|---|
| Value | Defines the value associated with the specified Key that Convoso uses when evaluating the external API response. | Text field within an External API Data Validation row. |
| Create Lead | Determines whether Convoso creates the Lead when the configured external API validation criteria are met. | Yes/No toggle. When set to No, the Status field becomes inactive. |
| Status | Specifies the Status/Disposition associated with the validation rule when applicable. | Drop-down containing available Statuses/Dispositions. Becomes inactive when Create Lead = No. |
| Add to DNC | Determines whether the Lead is added to the Do Not Call (DNC) list when the validation criteria are met. | Yes/No toggle. |
| Success | Defines the Success value associated with the External API Data Validation rule. | Yes/No toggle. |
| Action | Provides an option to remove an External API Data Validation rule. | Selecting Remove deletes the corresponding entry. |
5.) Click the Apply Changes button.
Please sign in and vote to let us know if you found this article helpful!
👇