Skip to main content

DotdigitalPro

This guide assumes you have a Dotdigital account already.

Compatibility

Uses v2 of the REST API.

Endpoints

Maps data to the following endpoints:

  • Contacts

Does your project require something else?   Contact Us

Fields

Maps data to the following field types:

  • Standard
  • Custom

Setup Instructions

1

Create & get API Key from Dotdigital

  • Go to the Dotdigital website and log into your account.
  • At the bottom left corner, click on the profile with cog icon, then click Access menu option.
  • Click on the API Users tab, and then click New User button.
  • Enter and confirm a password and take note of it for yourself.
  • After the page reloads, copy the auto generated API connector email address under the Email column.
2

Set up Integration on your site

  • Go to the Email Marketing section in Freeform Settings (Freeform → Settings → Email Marketing).

  • Click the New Integration button at the top right.

  • Select Dotdigital (v2) from the Service Provider select dropdown.

  • Enter a name and handle for the integration.

  • Paste the Dotdigital API connector email address into the API User Email field in Freeform.

  • Enter the chosen password for that API user in the API User Password field in Freeform.

  • Configure additional settings:

    • Email Opt In Type - choose one of the following:

      • Single

      • Double

      • Verified Double

        Setting this to Verified Double will result in a double opt-in confirmation email sent to the contact. The result will state that the contact's Opt-In Type is Double and the Status is Pending Opt-In. These will only update to Verified Double and Subscribed, respectively, once the contact has clicked the link in the confirmation email, at which point they will be added to the account.

        It is possible to update an existing contact using this operation. A duplicate contact will not be created. If the contact already exists, then any data provided in your request that is already held for the contact will be overwritten and updated in the system.

    • Email Type - choose one of the following:

      • Plain Text
      • HTML
  • Click the Save button.

3

Verify Authorization

  • After the integration is saved, it'll return you to the list of mailing list integrations.
  • Click into the newly created integration.
  • Confirm that there is green circle with Authorized in the middle of the page.
4

Configure the Form

To use this integration on your form(s), you'll need to configure each form individually.

  • Visit the form inside the form builder.
  • Click on the Integrations tab.
  • Click on Dotdigital in the list of available integrations.
  • On the right side of the page:
    • Enable the integration.
    • Choose a Freeform field to be the target opt-in field.
    • Select a mailing list that new users should be subscribed to.
    • Map Freeform fields to the Dotdigital fields as you wish.
Finished!

Testing

For testing or troubleshooting purposes, you can try using Dotdigital's demo login credentials:

  • Username: demo@apiconnector.com
  • Password: demo