Iterable's API can be used to interact with a project's contacts, templates, campaigns, journeys and more. To authenticate with the API, use an API key.
This document describes the types of API keys Iterable provides, how to create them and how to use them.
Table of contents
Types of API keys
Iterable provides four different types of API keys, each of which can access a different subset of Iterable's API endpoints:
If possible, when using a mobile API key, we recommend using JWT authentication for additional security.
Useful for calling Iterable's API in situations where data should only be read (never modified), this type of API key can access the following endpoints:
Server-side API keys can access all of Iterable's API endpoints, except for:
Creating API keys
To create API keys for an Iterable project:
Sign in to an Iterable project as an org admin or as a member that has the Project Configuration > Data Feeds, Third-Party Integrations, API Keys and Webhooks permission.
Navigate to Integrations > API Keys. This screen lists information about each of the API keys that have been created for the project, but it does not display the full API keys.
Click New API Key.
In the Create a New API Key window, enter a name for the key and select the type of API key you'd like to create. Then, click Create.
To use JWT authentication with a mobile API key, check Require JWT Authentication on the bottom of the window. Every call to Iterable's API that authenticates with a JWT-enabled API key must also include a valid JWT as the value of an
Authorizationheader (Bearer schema). For more information, read JWT-Enabled API Keys.
If you enable JWT authentication for an API key, you cannot later convert it to a different type of API key. For example, you cannot change a mobile API key that requires JWT authentication into a server-side API key.
In the Copy Your New API Key window, copy the API key:
If your API key requires JWT authentication, also copy the JWT Secret your server should use when generating per-user JSON Web Tokens:
Store the values displayed on this screen in a secure location. After you close the window, Iterable cannot display them again. If you lose them, you'll need to create a new API key.
Editing API keys
To change the type or name of an API key:
Navigate to Integrations > API Keys.
Click Edit for the API key you'd like to modify.
In Edit API Key window, provide updated values for an API key. Then, click Update.
You cannot change the type of an API key that requires JWT authentication.
Deleting API keys
To delete an API key:
Navigate to Integrations > API Keys:
Find the API key to delete. In its row, click the down arrow and select Delete Key.
Confirm the deletion.
Using API keys
All calls to Iterable's API should support TLS 1.2. Starting October 22, 2021, API calls that do not support TLS 1.2 will fail. For more information, see our release notes from September 22, 2021.
There are various ways to use Iterable API keys:
From Iterable's API docs. Paste the API key in the Authentication Header input (in the upper-left corner of the screen) and click Apply. Then, make API calls as necessary directly from the API docs.
curl -H "Api_Key: 7edf98199a5b49fa8bd016622432632a" https://email@example.com