Advanced Configuration Settings

While the default options will likely fit your needs, SugarChimp has a number of different configuration options to fit your CRM and Mailchimp needs. Read through the available configurations below and scroll to the bottom of the page to see how to make these updates. 

---

globaloptout

Description: Handles how Mailchimp unsubscribes are handled within your CRM. SugarChimp will always remove the matching records from the synced target list. Then, it will update the email records according to this setting. For more information see: SugarChimp Opt-outs and Hard Bounces  

Setting Value	Value Definition
0	If the email address is only on 1 synced target list, then mark it as invalid or opted out. If the record is on more than 1 synced target list, no changes are made.
1 (default)	Whether the email is on one or multiple synced target lists, the email is removed from all synced lists and marked as opted out.
2	Do not update the email address.

---

webhook_add_to_list

Description: When we get an update from Mailchimp, we will always update all matching email records who are currently on the target list. This configuration setting is for new subscribers from Mailchimp (or a Mailchimp to CRM re-sync) who have no matches on the target list. 

Note: the default module is the one selected in Step 4 of Sync Settings.  This module determines how records are created when new records are added in Mailchimp and sync back to your CRM.

Setting Value	Value Definition
0 (default)	Check for email matches based on list population settings.  If no filters selected, add all new incoming records from Mailchimp.
1	Add all matching records always.
2	Add default module records only. If none exist, do nothing.
3	Add default module records only. Create a new default module record if none exists.
4	Add default module records when they exist. Add other matching records if no default module records exist.
5	Nobody is ever added to the target list.

Here are two scenarios to see how the values are applied and help you determine which option fits your needs:

Scenario 1:
A target list in your CRM is synced to a Mailchimp audience where the default module is contacts. The list is set to keep 'All Contacts' automatically, with no automation for leads. A new person with email address ‘[e-mail]’ subscribes to the Mailchimp list.

In your CRM, there is a contact and a lead with the email address of ‘[e-mail]’, neither of which are on the target list. How do you want the integration to handle the new subscriber?

0 (default) - The contact and lead are checked against any list filters. The contact is added automatically (since all contacts are set to sync), while there is no automation for leads. The integration will skip over the lead, only add the contact to the target list and update their information.
1 - All matches are automatically added to the list, no checks. Add the contact and lead to the target list, update their information.
2 - Default module record is found (contact), ignore everything else. Add the contact only to the target list, update their information.
3 - Default module record is found (contact), ignore everything else. Add the contact only to the target list, update their information.
4 - Default module record is found (contact), ignore everything else. Add the contact only to the target list, update their information.
5 - Nobody is ever added to the target list.

Scenario 2:
A target list in the CRM is synced to a Mailchimp audience where the default module is contacts. The list is set to keep 'All Contacts' synced automatically, with no automation for leads. A new person with email address ‘[e-mail]’ subscribes to the Mailchimp list.

In the CRM, there are no records with that email address on the target list, but there is a lead with the email address of ‘[e-mail]’ in the system. How do you want the integration to handle the new subscriber?

0 (default) - The lead is checked against any filters (there are none for leads). The integration will add the lead to the target list and update their information.
1 - All matches are automatically added to the list, no checks. Add the lead to the target list, update their information.
2 - The lead is rejected because it is not the default module. Nothing is added to the list. Does not add the lead to the target list, no updates within the CRM.
3 - The lead is rejected because it is not the default module. A new contact is created. Create a new contact with Mailchimp data, add it to the target list.
4 - Check for matching contacts, but none exist. Because no contacts are found, add the lead to the target list and update their information.
5 - Nobody is ever added to the target list so no changes are made.

---

default_assigned_user

Description: Determines which user a new record created from Mailchimp is assigned to.

Setting Value	Value Definition
1 (default)	Defaults to the root CRM user. Change this value to the ID of the user you wish for the new records to be assigned to.

---

erroremail

Description: If SugarChimp has a problem, this is the email address that SugarChimp should alert.

Setting Value	Value Definition
[e-mail](default)	The default value is the CRM instance's root user's email address.

---

subscriber_sync_enabled

Description: Determines if Mailchimp can update or create new CRM records.

Setting Value	Value Definition
0	CRM records CANNOT be updated from Mailchimp.
1 (default)	CRM records CAN be updated from Mailchimp.

  

---

outbound_proxy

Description: Store your outbound proxy settings so that the integration can reach Mailchimp.

Setting Value	Value Definition
false	No outbound proxy is set.
proxy_ip:proxy_port (default)	Set your proxy value as ip:port. For ex. '123.456.2.34:8080'

 

---

How to Update Your Configuration Settings

To update your configuration settings you'll need two things: 
1. The name of the configuration settings you wish to change (setting_name).
2. The value that you wish the configuration setting to be (setting_value).

From there, you can update the setting in one of the following ways:

Directly Update Database

Do you have database access? If so, simply run this SQL command against your database to update the setting:

UPDATE config SET value=(insert setting_value) WHERE category='sugarchimp' AND name='(insert setting_name)';

For example: This query will update your globaloptout config to 2.

UPDATE config SET value=2 WHERE category='sugarchimp' AND name='globaloptout';

Sugar 7 and Above - Browser Console

If you don't have access to your database then you can do this through your browser console for Sugar 7.

1. Log into SugarCRM.
2. Right click and choose Inspect.
3. Select Console.
4. Copy and paste the following line of code and hit Enter. Your setting should now be updated.

SUGAR.App.api.call('get',SUGAR.App.api.buildURL('SugarChimp/setting/_setting_/_value_'),{},{});

SuiteCRM / Sugar 6 - API Endpoints

If you don't have access to your database then you change the settings by navigating to the endpoint for Sugar 6.

1. Log into your CRM.
2. Extend your base Sugar url as follows:

/index.php?module=SugarChimp&action=update_setting&key=(insert setting_name)&value=(insert setting_value)

1. Hit Enter to update the configuration setting.
2. Use the back button on your browser to get back to Sugar.