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
  • API Host
  • Headers
  • Example Request with Headers

Was this helpful?

  1. Developers

Authentication

Learn how to authenticate your app or integration with Retainful in order to use the API

API Host

All API requests should be sent to the following host:

apiv2.retainful.net

Headers

All requests to Retainful’s API must include the following HTTP headers:

Retainful-Api-Key

Your Retainful API Key. Keep this credential confidential.

Retainful-App-Id

Your Retainful App ID.

Example Request with Headers

POST /v2/contacts
Host: apiv2.retainful.net
Retainful-Api-Key: <YOUR_API_KEY>
Retainful-App-Id: <YOUR_APP_ID>
Content-Type: application/json

PreviousGetting startedNextContacts

Last updated 4 days ago

Was this helpful?