Referral Hero Documentation
Getting StartedFeaturesIntegration
  • Introduction to ReferralHero
  • Getting Started
    • Quickstart
    • Creating a New Campaign
      • Choose a Campaign Type
      • Set Your Goals
      • Define a Unique Identifier
      • Set Up Integrations
      • Set Up Automations
      • Configure Options
  • Features
    • Subscribers
      • Types Of Subscribers
  • Integrations
    • Overview
    • Embeddable Widgets
      • Advocate Dashboard Widget
      • Referral Signup Widget
      • Referral Welcome Banner
      • Sharing Widget
      • Floating Button
      • Customize the Widgets
    • Javascript Web API
      • Getting Started
      • Configuration File
      • Callbacks
      • Add a Subscriber
      • Add a Pending Referral
      • Track multi-step conversion events
      • Track Transaction
      • Identify a Subscriber
      • Identify a Referrer
      • Generate Dashboard Widget
      • Generate Sharing-Screen
    • React JS
    • Platform Specific Integration
      • Shopify
      • Webflow
      • WordPress
    • Mobile SDK's
      • React Native
        • Getting Started
        • Mobile App Testing in Development Mode
    • REST API
      • Lists
        • 🟠POST lists
        • 🟢GET lists
        • 🟢GET lists/:uuid/leaderboard
        • 🟢GET lists/:uuid/bonuses
    • API Tutorials
Powered by GitBook
On this page
  1. Integrations
  2. REST API
  3. Lists

POST lists

PreviousListsNextGET lists

Last updated 5 months ago

Create a new list

POST

Create a new list/campaign in your account.

Path Parameters

Name
Type
Description

website

string

Default Referral URL

name

string

Your List Name

api_token

string

Your API Token

Response

{
  "status": "ok",
  "data": {
    "uuid": "MF521c3aade8",
    "name": "My amazing sweepstake",
    "created_at": 1731936007,
    "subscribers": 0,
    "response": "list_created"
  },
  "calls_left": 1000,
  "timestamp": 1731936007
}
🟠
https://app.referralhero.com/api/v2/lists