Funnels

List All Funnels

Retrieve all funnels for a project.

string

required

The brand/project ID

Request

GET /api/brands/{brand}/funnels/all

cURL

curl https://app.elasticfunnels.io/api/brands/{brand_id}/funnels/all \
  -H "EF-Access-Key: your_api_key_here"

{
  "data": [
    {
      "id": 1,
      "name": "Main Sales Funnel",
      "status": "active",
      "pages_count": 4,
      "created_at": "2024-01-15T10:30:00.000000Z"
    }
  ]
}

Get Funnel Details

Retrieve details about a specific funnel.

string

required

The brand/project ID

string

required

The funnel ID

Request

GET /api/brands/{brand}/funnels/{funnel}

cURL

curl https://app.elasticfunnels.io/api/brands/{brand_id}/funnels/{funnel_id} \
  -H "EF-Access-Key: your_api_key_here"

{
  "id": 1,
  "name": "Main Sales Funnel",
  "status": "active",
  "pages": [
    {
      "id": 1,
      "name": "Landing Page",
      "type": "landing",
      "order": 1
    },
    {
      "id": 2,
      "name": "Checkout",
      "type": "checkout",
      "order": 2
    },
    {
      "id": 3,
      "name": "Upsell",
      "type": "upsell",
      "order": 3
    },
    {
      "id": 4,
      "name": "Thank You",
      "type": "thankyou",
      "order": 4
    }
  ],
  "created_at": "2024-01-15T10:30:00.000000Z",
  "updated_at": "2024-12-10T08:20:00.000000Z"
}

Create Funnel

Create a new funnel.

string

required

The brand/project ID

string

required

Funnel name

string

Funnel status: active or inactive (default: active)

Request

POST /api/brands/{brand}/funnels

cURL

curl -X POST https://app.elasticfunnels.io/api/brands/{brand_id}/funnels \
  -H "EF-Access-Key: your_api_key_here" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "New Funnel",
    "status": "active"
  }'

Update Funnel

Update an existing funnel.

string

required

The brand/project ID

string

required

The funnel ID

Request

PUT /api/brands/{brand}/funnels/{funnel}

cURL

curl -X PUT https://app.elasticfunnels.io/api/brands/{brand_id}/funnels/{funnel_id} \
  -H "EF-Access-Key: your_api_key_here" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Updated Funnel Name"
  }'

Delete Funnel

Delete a funnel.

string

required

The brand/project ID

string

required

The funnel ID

Request

DELETE /api/brands/{brand}/funnels/{funnel}

cURL

curl -X DELETE https://app.elasticfunnels.io/api/brands/{brand_id}/funnels/{funnel_id} \
  -H "EF-Access-Key: your_api_key_here"

Clone Funnel

Create a copy of an existing funnel with all its pages.

string

required

The brand/project ID

string

required

The funnel ID to clone

Request

POST /api/brands/{brand}/funnels/{funnel}/clone

cURL

curl -X POST https://app.elasticfunnels.io/api/brands/{brand_id}/funnels/{funnel_id}/clone \
  -H "EF-Access-Key: your_api_key_here"

{
  "id": 2,
  "name": "Copy of Main Sales Funnel",
  "status": "inactive",
  "pages_count": 4,
  "created_at": "2024-12-10T16:00:00.000000Z"
}

Getting Started

Endpoints

List All Funnels

Get Funnel Details

Create Funnel

Update Funnel

Delete Funnel

Clone Funnel

​List All Funnels

​Get Funnel Details

​Create Funnel

​Update Funnel

​Delete Funnel

​Clone Funnel

List All Funnels

Get Funnel Details

Create Funnel

Update Funnel

Delete Funnel

Clone Funnel