Retainful Knowledge Base
  • Retainful Knowledge Base
  • Installation
    • WooCommerce
    • Shopify
    • Setting up a Sending Domain
  • Automations
    • Welcome Email Series
    • Abandoned Cart Recovery Emails
    • Thank you Email Series
    • Win Back Emails
    • Product Review Request Email
    • Order Follow Up Emails
    • Product Specific Follow Up Emails
    • Automation Workflow Settings
      • Entry Rules
      • Trigger Rules
      • Customer Rules
      • Exit Rules
      • Block / Steps
    • Smart Sending
    • Smart Delay
  • EMAIL SETTINGS
    • Email Drag and Drop Editor
    • Save as Template
    • Adding a store logo on your email template
    • Adding a Coupon Block to Your Email Template
  • Campaigns
    • Creating a Campaign
  • AUDIENCE
    • Getting started with List & Segments
    • Creating a List
    • Creating a Segment
  • Signup Forms
    • Add to Cart Popup
    • Exit-Intent Popup
    • Welcome Popup
    • Embed Form
    • Enabling Signup Forms In Retainful Settings
    • Popup Editor
    • Popup Triggers
    • Popup Targeting
  • Contacts
    • What is a Contact
    • Import Contacts From Store
    • Import Contacts From CSV File
  • Metrics & Cart Activity
    • Cart Activity
    • Conversions
    • Automation Outbox
    • Campaign Outbox
  • Teams
    • Invite Team Members
  • SETTINGS
    • Retainful Settings
      • General
      • Email
      • Suppression List
      • UTM Parameters
    • Retainful - WooCommerce Plugin Settings
  • Integrations
    • MailChimp
    • MailerLite
    • Klaviyo
    • HubSpot
    • Brevo (Formerly SendInBlue)
    • Active Campaign
    • ConvertKit
    • Zapier
    • Migrate To Improved Integrations
  • HOW TO's
    • How to Insert Retainful's Shortcodes
    • How to Resolve Cart Recovery Emails Sent After Order Placement
    • How to Create Dynamic Coupon Codes in Emails
    • How to check conversions
    • How to ensure GDPR compliance - Marketing Consent
    • What Are Opt-In Settings and How Can You Configure Them?
    • How to Manage Multiple Stores with Retainful
    • How Can You Improve Email Deliverability
    • Best Practices for Higher Deliverability & Engagement
    • Sending Domain
      • GoDaddy
      • Hostinger
    • Google & Yahoo Sender Requirements
    • How Customer's Email Address is captured?
    • How Retainful Tracks Conversions with Coupon Codes?
    • How to delete a Bounce-back email or a failed email address?
    • How Was My Store Account Deleted?
    • How to insert coupon codes in automation emails?
    • How Can You Use Google Fonts in Retainful Email Templates?
  • Developers
    • Getting started
    • Authentication
    • Contacts
    • Lists
Powered by GitBook
On this page
  • Introduction
  • Creating the API Key
  • API Host
  • Working with Retainful API

Was this helpful?

  1. Developers

Getting started

Integrate your apps, plugins and extensions with Retainful using our simple, developer-friendly RESTful API

Introduction

Welcome to the Retainful API! Our platform streamlines marketing automation, making it easy for developers to integrate audience management, personalized messaging, and growth-driven campaigns into their applications. Whether you need to add or update contacts, or automate welcome messages, Retainful provides a straightforward, developer-friendly REST API.

With flexible permissions, clear documentation, and robust endpoints, you can quickly build and scale your marketing workflows—no complicated configurations required.

In the sections that follow, you’ll learn how to set up your API credentials, manage contacts and lists, and customize key aspects of your automation. If you have any questions along the way, our Help Center and support team are here to assist.

Let’s get started!

Creating the API Key

Head over to your Retainful Account dashboard -> Settings -> API Keys section.

  1. Click Create API Key to generate a new key.

  2. Set the Permissions:

    • Full Access: Read and write access to all endpoints.

    • Read-only: Read access only—API key cannot modify or write any data.

    • Custom Access: Customize the access level for the key for different endpoints.

  3. Save or copy your new API key securely.

API Host

apiv2.retainful.net

Working with Retainful API

Once you created the API Key, following these steps to start working with the Retainful API

  • Find Your App ID

    • In the Settings → General section, you will also see your App ID. You need to send the App ID in each request.

  • Add Headers to Every Request Retainful’s API requires the following headers for authentication in each request:

    Retainful-Api-Key: YOUR_API_KEY
    Retainful-App-Id: YOUR_APP_ID

    Replace YOUR_API_KEY and YOUR_APP_ID with the actual values from your account.

  • Use the Endpoints

  • Test Your Requests

    • Use tools like cURL or Postman to verify connectivity and ensure your API key permissions are set correctly.

  • Build & Integrate

    • Once you’ve confirmed authentication and permissions, integrate the API calls into your application or automation workflows.

PreviousHow Can You Use Google Fonts in Retainful Email Templates?NextAuthentication

Last updated 26 days ago

Was this helpful?

Refer to the documentation for creating or updating contacts.

Refer to the documentation for retrieving audience lists.

Contacts API
Lists API