Proper configuration of your Campaign Studio instance is important for branding, performance, and the user experience of your team working in the instance.

Configuring the instance¶

1. Login to your Campaign Studio instance.
2. In the upper right corner, click the Settings gear icon to expand the menu.
3. Click the Configuration tab and the Configurations menu appears on the left.
4. Click the tab in the menu you want to configure.

System settings¶

General settings¶

• Mautic’s root URL: When a user signs in to their Campaign Studio instance, they go to customdomain.domain.com (the root URL). That page is accessible to the public. If a contact visits the root address, they see the Campaign Studio login page for the instance. Create a Campaign Studio landing page to greet contacts visiting your root URL.

  Once you’ve done that, users can sign in to Campaign Studio by visiting https://customdomain.domain.com/s/login.

• 404 page: Select the page that you want to use as the 404 page. If you don’t want to use Campaign Studio’s default 404 error page, create a custom landing page and select that page here. If you don’t select any page, Campaign Studio uses the default error page.

System defaults¶

• Default item limit per page: The number of contacts, campaigns, emails, etc. which each page when you go to an item section. The default is 10.

• Default timezone: The users’ default time zone, typically set to the time zone of the company headquarters. Time zones can be set for individual users. The default is UTC.

  For example: Headquarters is in Boston and the default is set to US Eastern Time (America New York). A user in San Francisco (US Pacific Time America Los Angeles) can display Pacific Time in the user interface.

• Default language: The initial language assigned to users. Individual users may select their own settings. Campaign Studio uses English - United States by default.
• Cached data timeout (minutes): Campaign Studio caches data to speed up page loads. Update this setting to change how long Campaign Studio caches the data. Campaign Studio uses 10 minutes as the default.
• Date Range Filter Default: Sets the default for how far back from the current date Campaign Studio looks for data in reports (including campaign and email snapshots reports on the item page. If you’ve changed the setting on a report, Campaign Studio uses what you’ve entered. Campaign Studio’s default value is 1 Month.
• Default format for full dates, date only, short dates, and time only: The defaults are set for standard US time format. See the PHP manual for date functions to change formats.

CORS settings¶

Cross-Origin Resource Sharing (CORS) enables data to pass between your website and Campaign Studio.

• Restrict Domains: When set to No, any web page can pass information to Campaign Studio. Select Yes to limit communication with your Campaign Studio instance to websites listed in Valid Domains.

• Valid Domains: A list of domains allowed to communicate with your Campaign Studio instance. In the text box, list the exact URL of the top level domain you want to enable, one per line. For example: https://www.acquia.com tracks any activity on acquia.com pages, but http://www.acquia.com won’t because acquia.com is a secure website.

  Note

  In the Valid Domains field, don’t include a slash at the end. For example, use https://www.acquia.com instead of https://www.acquia.com/.

Miscellaneous settings¶

• IP lookup service: By default, Campaign Studio uses MaxMind GeoLite2 City to identify the city of a website visitor, based on the location of the Internet Service Provider (ISP) for their IP address.
• IP lookup service authentication: To use another available IP lookup service, enter your credentials.
• List of IPs not to track contacts with: To disable tracking for particular IP addresses, enter the addresses, one per line. Acquia doesn’t recommend adding your office IP address. If you list your internal IP address, Campaign Studio won’t track clicks, page hits, etc., from that IP, including testing clicks.
• List of Bots to not track with: Campaign Studio has identified and disabled tracking for several known bots. To track activity from those bots, remove them from this list. To disable tracking for other bots, add them here (one per line).

• URL Shortener: If you use a URL shortening service like bit.ly for links in SMS messages, enter your access token here. For bit.ly, use:

  copy

  https://api-ss..bitly.com/v3/shorten?access_token=[ACCESS_TOKEN]&format=txt&longUrl

• Item max lock time: When a user edits a campaign, email, landing page, etc., Campaign Studio locks the item to prevent simultaneous edits by other users. When the initial user saves and closes or cancels out, the item may remain locked for this period of time. The default is 0 seconds.
• Translate page titles: To translate page titles from non-Latin (non-English) characters to Latin characters (English).

Theme settings¶

• Default theme: Applies a theme to any form which doesn’t have a theme already applied. If you don’t have a landing page for your preference center, but have preference settings turned on in Email settings, Campaign Studio creates a default preference center page using the form styling from the theme selected here.

API settings¶

To use the API functionality in Campaign Studio, do the following:

1. In Settings > Configuration >  API Settings, verify the API settings:
   • API enabled: Select Yes to pass data in and out of Campaign Studio through the API.
   • Enable HTTP basic auth?: Enables basic authentication for Campaign Studio’s API. Acquia recommends only using with secure sites (HTTPS).

   • Access token lifetime: When authorizing a new application or integration, limits how long the access token is valid (in minutes). The default is 60 minutes.

     For example: You add a new integration to your SaaS platform. Enter 30 here to limit the access token validity to 30 minutes. If you haven’t completed the authentication in that period of time, you must revalidate.

   • Refresh token lifetime: When using OAuth 2.0, the lifetime of the refresh token used to request a new access token once expired. Once the refresh token expires, you must reauthorize. The default is 14 days.

     

2. In Settings > API Credentials, configure the API credentials.

   Full API documentation is available here.

Campaign settings¶

• Wait time before retrying a failed action: If for any reason a campaign action doesn’t execute, Campaign Studio waits the set length of time before trying again.

Email settings¶

Mail Send Settings¶

• Name to send mail as: The default name emails come from. This is typically something like {YourCompany} Marketing Team or {YourCompany}.

  Note

  This field supports tokens. For more information, see Advanced in Email Basics.

• Email address to send mail from: The email address for the name you’re sending mail from. The address displays in the From: field when your contacts receive your emails.

  Note

  This field supports tokens. The sender domain used must be configured and verified. For more information, see Advanced in Email Basics.

  Ensure that you configure your sender domain, DKIM, bounce, and click tracking domains. For more information, see email domains document.

• Reply to address: To have contacts reply to a different address than the address defined in Email address to send mail from, add the desired address to receive replies. This is the default address where messages are sent whenever contacts reply to messages sent from Campaign Studio. If this field is blank, the address specified in Email address to send mail from is used. This is useful if your configured sender domain, which you use in the from address, contains a subdomain that does not have MX records or is otherwise an address that cannot receive emails.
• Mailer is owner: If contacts in Campaign Studio have Owners, select Yes to display the owner as sending all emails to the contacts they’re listed as the owner for. Mailer is owner overrides any other name or email to send mail from, including the default and individual emails. Every contact owner’s domain must have SPF and DKIM records. You can see this configuration for individual emails, rather than globally. See Mailer is owner.
• Disable unsubscribe link in header: Toggle this setting to Yes if you do not want Campaign Studio to add a one-click unsubscribe header to these emails. By default, Campaign Studio adds a one-click unsubscribe header to marketing or non-transactional emails with Send to unsubscribed contacts set to No in the Advanced tab on the Emails page. For more information, see Transactional and Marketing emails.
• Service to send mail through: Campaign Studio provides Sparkpost as the default delivery partner.  Mautic is the default setting to route your emails through the Campaign Studio Sparkpost account. However, if you are sending emails through your own email service, select the service and enter your credentials. For more information, see Configuring your own email transport.
• Custom headers: Define custom headers that you want to use for outgoing emails if you are not using Sparkpost as the default delivery partner. A custom header defined in Email Settings only applies when creating custom content using Send a custom email for a contact. It does not function as the default custom header for all outgoing emails. For all other email types, you must define custom headers at the individual email level on the Advanced tab on the Email page. Global Tokens are not supported in Custom Headers.

Pause communication¶

Campaign Studio provides an option to pause email communication for a defined time and date range. This option is applicable to segment emails, and "Send Email to Contacts" and "Send Marketing Message" campaign events.

• Pause From: Start date to pause email communication for a defined time and date range.
• Pause to: End date to pause email communication for a defined time and date date range.

Default frequency rule¶

• Do not contact more than <number> each <period>: This limits the number of non-transactional type emails that a contact can receive in a certain period of time (day, week, month). Transactional or operational type emails do not count towards this limit. You can adjust the frequency rule at the individual contact level, either manually or by preference center setting. For more information, see Transactional and Marketing emails and Frequency rule.

Monitored inbox settings¶

• Default Mailbox: This inbox is where you receive bounce notifications from emails sent.
• Contact Replies: Like the monitored inbox for bounces, Campaign Studio checks this inbox for contact replies. Configure this to use Replies to email decisions in any campaigns. If Use custom connection settings? is set to No, Campaign Studio checks the default mailbox. If set to Yes, you may track a different mailbox for replies.

Message Settings¶

• Text for the {webview_text} token: The message indicating the reader can view the email in their browser. The default is:

  copy

  Having trouble reading this email? Click here.
                                                                  To change the text, change the message between the ``<a href="|URL|">`` and
                                                                  ``</a>`` tags. Don't change the ``|URL|`` text, because that is a token for
                                                                  each contact.

• Default email signature: The signature for your default emails, which pairs with the name & email address in the Mail Send settings.
• Append tracking pixel into email body?: To track email opens, select Yes. Select No to prevent tracking, reporting on, and using decisions based on email opens.
• Convert embed images to Base64: Select Yes to display embedded images in emails as code rather than as images.
• Disable trackable URLs: Removes tracking from URLs in your emails. Select Yes to prevent tracking, reporting on, and using decisions based on link clicks. Some email service providers don’t like redirecting URLs. Using trackable URLs in your emails may impact deliverability.

Unsubscribe settings¶

Configure the following fields to ensure that your contacts can see your preference center landing page.

Text for the {unsubscribe_text} token: Change a basic

Unsubscribe link to a personalized message. For example, Update your contact preferences or Do not want to hear from us anymore? Click here.

• <a href="|URL|">Unsubscribe</a> to no longer receive emails from us.
                                                  

Edit between the anchor (<a href=|URL|"> </a>) tags. The URL is a token, so do not change it. To use custom text on an email, hyperlink the text with the {unsubscribe_url} token as the link.

Unsubscribed and resubscribed confirmation message: If a contact

unsubscribes or resubscribes, the message in this field displays on the page after the respective action.

• Note

  Do not edit the |EMAIL| or |URL| tokens in the <a href> tag.

Show contact preference settings: When set to Yes, the

unsubscribe link directs the user to the preference center.

If this option is set to Yes and a contact clicks the Unsubscribe link, the contact will see the preference center that is created and configured for the email from which the contact clicked the Unsubscribe link. If no preference center is configured for that email, the contact will see a default preference center page. The configuration option for default theme determines the styling of the default preference center page.

If this option is set to No, contacts who click the Unsubscribe link in an email see a page with the Unsubscribed confirmation message.

Show contact segment preferences: Toggle the setting to Yes to

enable a contact to change which segments they are part of on the preference center page. Segments display on the preference center page if they are published and public.

Show contact frequency preferences: Toggle the setting to Yes

to enable an individual to limit the number of marketing messages they receive on each channel from the preference center.

Show pause contact preferences: When set to Yes, a contact can

disable messages from your Campaign Studio account to their email address for a specified date range. This is not a full unsubscribe. At the end of the date range the messages resume sending to the contact.

Show contact’s categories: If you have categories set for contacts,

campaigns, emails, etc., and set this option to Yes, the contact can opt out of the categories they choose from the preference center page.

Show contact’s preferred channel option: If you have multiple channels

available in your Campaign Studio account (email, SMS, mobile push, web notifications, etc.), contacts may choose their preferred channel. This can be useful when using the Marketing Messages Marketing Messages feature of Campaign Studio.

Form settings¶

Do not accept submission from these domain names: To block contacts with specific email domains from submitting your forms, enter those domains in the dialog box. Select an option on each form you want to apply this block to. You can restrict either specific email aliases that belong to a domain or an entire domain. To block the entire domain, you can use wildcards (*). For more information, see Blocking domains from submitting forms.

Segment settings¶

• Show warning if segment hasn’t been rebuilt for X hours: For all contacts, dynamic segments get rebuilt nightly. If there is an error that prevents a segment from rebuilding, Campaign Studio displays a warning message. This field allows you to configure the allowable length of time between rebuilds, post which the warning message appears.

Notification settings¶

If a campaign or webhook is automatically unpublished because of a high volume of errors, Campaign Studio sends a notification alerting users.

• Send notification to author: Set this field to Yes to send an email notification to the user who created the unpublished campaign or webhook. If the user is deleted, no notification is sent.
• Email addresses to receive notifications: To send notifications to users other than the author, enter a comma-separated list of email addresses. You can include distribution lists and addresses of the users who are not present in the Campaign Studio instance.

Landing page settings¶

• Show category in page URL?: If you use categories, the landing page’s associated category displays in the URL if you select Yes.
• Analytics script: To track landing page visits and activity in other platforms such as Google Analytics 4, add those tracking scripts here.

Tracking settings¶

Campaign Studio tracking settings¶

• Tracking code: Insert this code on any page you would like to have tracked in Campaign Studio before the ending </body> tag.

  Note

  The default tracking code provided in a new instance updates and changes after you set up a new custom domain or when you make changes to an existing one. You must use the new tracking code that reflects the new or edited custom domain. If you are using the plugin for WordPress, Drupal, or Joomla, re-enter your account information in the plugin.

  Multiple tracking scripts can be implemented on one website to send data across multiple instances. For each instance where you want to send data, make the following changes in the script:

  • Change the URL of the instance
  • Change the mt unique identifier to a different unique identifier in both places of the script
• Identify visitor by tracking URL: Select Yes to have Campaign Studio begin tracking a contact after the contact clicks a link in an email on a device where no cookie exists.
• Anonymize IP: Select Yes to not store full IP addresses for your visitors/contacts. This setting aids customers in achieving GDPR compliance.
• Do Not Track 404 error for anonymous contacts: Select Yes to not track page hits on any 404 error page tracked by the tracking code. This option helps prevent bots tracking.
• Append Segment IDs to Tracking URLs: When enabled, contact segment IDs are appended as a query parameter (segment_ids=1,2,3) to redirected URLs. This allows third-party tools like Conversion Optimization to identify segment memberships of the contact for personalized content delivery.

Facebook Pixel¶

• Facebook Pixel ID: Enter your Facebook Pixel ID and select the options you’d like to use the pixel for.
• Enabled on your tracking page: Select Yes to have Campaign Studio append the Facebook Pixel to the Campaign Studio tracking code to track pages where the tracking code exists.
• Enabled on Mautic landing page: Select Yes to have Campaign Studio add the Facebook Pixel to Campaign Studio landing pages.

Google Analytics¶

• Google Analytics ID: Enter your Google Analytics ID and select the options you’d like to use the pixel for.
• Enabled on your tracking page: Select Yes to have Campaign Studio append the Google Analytics 4 script to the Campaign Studio tracking code to track pages where the tracking code exists.
• Enabled on Mautic landing page: Select Yes to have Campaign Studio add the Google Analytics 4 script to Campaign Studio landing pages.
• Enabled IP Anonymization: For subscribers sensitive to GDPR or other data privacy laws and regulations, select Yes to anonymize the IP address of web visitors before sending it to Google Analytics 4.

Report settings¶

• Always quote data in CSV export: Select Yes to wrap each Campaign Studio field in double quotation marks when exported to a CSV file. For example: "First Name",``”Last Name”,””, ``"some text".

Text message settings¶

• Select default transport to use: If you have configured a delivery service for SMS messages, select the service here to send messages. You must configure a delivery service before selecting it here.

User/Authentication settings¶

SAML SSO settings¶

• Identity provider metadata file: Upload the metadata XML file from your IDentity Provider (IDP) here.
• Default role for created users: With user roles created in the Roles section of the settings panel, you may select one of those roles as the default for users created using SSO. If empty, Campaign Studio users won’t be created using SSO. See Roles.

Enter the names of the attributes the configured IDP uses for the Campaign Studio user fields. Match the field name from your identity provider to the field name Campaign Studio uses for user creation.

• Email
• First name
• Last name
• Username

Use a custom X.509 certificate and private key to secure communication between Campaign Studio and the IDP. Upload your:

• X.509 certificate
• Private key file
• Enter your Private key encryption password

For more information, see SAML Single Sign On (SSO).

OpenID Connect settings¶

You can use an OpenID Connect provider to set up single sign-on (SSO) and multi-factor authentication (MFA) for authorization and authentication of users through external providers.

For more information, see OpenID Connect.

DAM Integration Settings¶

Campaign Studio provides integration with Acquia DAM so you can use Acquia DAM assets in your emails and landing pages.

In the Subdomain field, enter only the name of the subdomain of your DAM account. For example, if your subdomain is https://mysubdomain.com, then only enter mysubdomain in the Subdomain field.

For more information, see: What URL options are available for my Acquia DAM site?. If you do not know the subdomain of your DAM account, contact your DAM account manager or create a Support ticket.

Webhook settings¶

• Order of the queued events: If several events are queued in a webhook, process the events in chronological or reverse chronological order.