Sign in
latestOpenAPI 3.0.12026-08-21183382785.0 KB

24caa8eb809b

Funnels

Create funnel (legacy)

Create a new funnel, assign it a name and description matching your business needs. <br> <br> <br> This endpoint is for Audience Studio legacy. For the latest Audience Studio, contact your Customer Success Representative.

post/audiences/{audienceId}/funnels

Path parameters

audienceIdinteger required

Master Segment ID

Request body

namestring required

name

descriptionstring

description

segmentFolderIdinteger required

Example request

{
  "stages": [
    {
      "name": "Awareness"
    },
    {
      "id": 1,
      "name": "Interest"
    },
    {
      "name": "Conversion"
    }
  ]
}

Response

Succeeded to create funnel

idstring integer
audienceIdstring integer
segmentFolderIdstring integer
namestring
populationinteger nullable

The latest population of the funnel

descriptionstring
numSyndicationsinteger
needToRunWorkflowboolean

true if need to run workflow to load data

createdAtstring date-time
updatedAtstring date-time

Example response

{
  "stages": [
    {
      "id": "1",
      "name": "Awareness",
      "numSyndication": 2,
      "audienceId": "1",
      "funnelId": "10",
      "segmentFolderId": "30",
      "segmentId": "999"
    },
    {
      "id": "2",
      "name": "Interest",
      "numSyndications": 0,
      "audienceId": "1",
      "funnelId": "10",
      "segmentFolderId": "30",
      "segmentId": ""
    },
    {
      "id": "3",
      "name": "Conversion",
      "numSyndications": 0,
      "audienceId": "1",
      "funnelId": "10",
      "segmentFolderId": "30",
      "segmentId": ""
    }
  ]
}