Custom API Integration Requirements

Overview

Wunderkind integrates with your ESP or CRM in order to power our email program. We have pre-existing integrations with most ESPs, but we can also utilize any API, provided it meets our requirements below.

General API Requirements

1. Authentication 
   • Supported authentication methods include API Key, Client ID and Secret, or Username and Password
2. API Endpoints
3. Proper error handling
4. Must be able to use email address to make relevant API calls

Minimum Functional Requirements

1. Create new subscribers: collecting and sending a new email address to your system. Please provide information on whether we should reject duplicate submissions, as well as any additional required data points outside of email address.
2. Get subscription status: looking up users’ subscriber status by making a call to either (a) see if a user is on a list using an email address or (b) retrieving a user profile and checking an attribute.
   1. Information should be provided on how to treat user’s that are not present in your system. In the United States, it’s legal to email anyone that is not explicitly unsubscribed (for example, an email we’ve identified but not present in your CRM).
   2. Set subscription status: updating users’ subscription status, should they unsubscribe from a Wunderkind email

   3. Set subscription status: updating users’ subscription status, should they unsubscribe from a Wunderkind email

Nice-to-Have Functions

1. Customer State Check: look up users’ customer status, in a similar method as the “Get” subscription status, to determine whether someone is an existing customer. This may be used for segmentation purposes.
2. URL Appending & ID Lookup: the ability to append a unique, non-PII identifier to your email links, as well as the ability to query that identifier and return back the email address associated with that identifier. This is used to identify users that click through your marketing emails, increasing Wunderkind’s ID rate and triggered send pool.

Build & Test Process

After providing API documentation per the specs above, the Wunderkind engineering team will review and reach out with any follow-up questions.

UI Access to your system, as well as technical support, for the Wunderkind team is preferred so we can seamlessly build and test the integration on our side.