API Keys

Iterable's API can be used to interact with a project's contacts, templates, campaigns, workflows, 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 type can access a different subset of Iterable's API endpoints:

• Javascript SDK

  Useful for calling Iterable's API from front-end JavaScript code, this type of API key can access the following endpoints:

  • POST /api/users/update
  • POST /api/events/track
  • POST /api/commerce/trackPurchase
  • POST /api/commerce/updateCart

• Mobile

  Useful for calling Iterable's API from mobile apps (for example, when using Iterable's iOS SDK, Android SDK or React Native SDK) this type of API key can access the following endpoints:

  • POST /api/users/disableDevice
  • POST /api/users/registerDeviceToken
  • POST /api/users/update
  • POST /api/users/updateEmail
  • POST /api/users/updateSubscriptions
  • POST /api/commerce/trackPurchase
  • POST /api/commerce/updateCart
  • POST /api/events/trackPushOpen
  • POST /api/events/trackInAppOpen
  • POST /api/events/trackInAppClick
  • POST /api/events/trackInAppClose
  • POST /api/events/trackInAppDelivery
  • POST /api/events/inAppConsume
  • POST /api/events/track
  • POST /api/push/target
  • GET /api/inApp/getMessages

• Read Only

  WARNING

  Never embed Read Only API keys in client-side code (whether JavaScript, a mobile application or otherwise), since they can be used to access project data. Use Read Only API keys only when making API calls from your servers.

  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:

  • GET /api/campaigns
  • GET /api/channels
  • GET /api/messageTypes
  • GET /api/lists
  • GET /api/users/getFields
  • GET /api/metadata
  • GET /api/campaigns/metrics
  • GET /api/experiments/metrics
  • GET /api/templates
  • GET /api/templates/email/get
  • GET /api/templates/push/get
  • GET /api/templates/sms/get
  • GET /api/templates/getByClientTemplateId
  • GET /api/templates/inapp/get
  • GET /api/lists/{listId}/size
  • GET /api/campaigns/recurring/{id}/childCampaigns
  • GET /api/metadata/{table}
  • GET /api/metadata/{table}/{key}

• Standard

  WARNING

  Never embed Standard API keys in client-side code (whether JavaScript, a mobile application or otherwise), since they can be used to access all of your project's data. Use Standard API keys only when making API calls from your servers.

  Standard API keys can access all of Iterable's API endpoints.

# Creating API keys

To create API keys for an Iterable project, follow these steps:

1. 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.

2. 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.

3. Click New API Key.

4. 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.

   

5. In the Copy Your New API Key window, copy the API key by clicking Copy API Key:

   

   Store the key in a secure location. After you close the window, Iterable will never display the API key again.

# Editing API keys

To edit API keys for an Iterable project, follow these steps:

1. Navigate to Integrations > API Keys:

2. Click the Edit button contained within the row of the key to be edited

   

3. In Edit API Key window, provide updated values for an API key. Then, click Update.

   

# Deleting API keys

To delete API keys, follow these steps:

1. Navigate to Integrations > API Keys:

2. Find the API key to delete. In its row, click the down arrow and select Delete Key.

   

3. Confirm the deletion by clicking Delete.

   

# Using API keys

There are various ways to use Iterable API keys:

1. 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 from that page.

2. With a third-party tool such as Postman, Insomnia or curl:

   Use the API key as the value for an Api_Key or Api-Key request header. For example:

   curl -H "Api_Key: 03a41af536284de7b2d02482db54fb27" https://api.iterable.com/api/users/docs@iterable.com
   

3. With Iterable's JavaScript SDK.

4. With Iterable's iOS SDK.

5. With Iterable's Android SDK.

6. With Iterable's React Native SDK.

# Further reading

• Iterable's API documentation
• API Overview and Sample Payloads