Simple Email Marketing
Home > Have a question? We're here to help. > Account how-to > Our open API

Our open API

Table of contents

An application programming interface, or API, is an interface that allows developers to get other programs talking with your account. Let's say you'd like to sync up your audience or response data with an outside database, or that you want to add new contacts to your account through a custom signup form on your website. You'd use our API to make it happen.

To see what's available with our API – and what's involved in making calls to the API – pass this documentation along to your web development team. You'll want to be familiar and comfortable with this type of work before moving forward, but we do offer support for our API through our technical services team. That work starts at $199, and you can get started here!

If you decide to proceed, your developers will need a key, or set of credentials, for authentication. You can generate that right within your account by clicking "your name" in the top right and selecting, Account. From there, you'll see the API key tab, which you'll click. Lastly, click Generate API key to receive a public API key, private API key and account ID. 

Either the public key or private key will be used in all API calls. You'll want to share those with your developers so they can get started.

You'll want to jot down your private API key once you generate it, as it will be encrypted when you leave the page.

If you're an Emma HQ account user, click Menu and select Accounts. Click the downward-pointing arrow to the right of the account whose API key you want to generate, and select View account settings. Scroll down to the API key section to generate the key.

Keep in mind that a subaccount must have at least one team member for an Owner or Manager to generate an API key and the only subaccount permission level able to generate an API key is Administrator.

Helpful tip

A popular and fairly simple way to use the API is connecting a custom form hosted on your site directly to your audience groups. That can be done with the import_single_member call. You can access documentation for that call, as well as sample PHP to help you get started here.

 

Last modified

Tags

Classifications

This page has no classifications.

Announcements

Emma phone support will be unavailable on November XX, between the hours of XX:XX and XX:XX. You can still contact support using the link above and we will respond as soon as we can.

App status