Skip to main content
POST
/
api
/
public
/
v1
/
funnels
Create a new funnel
curl --request POST \
  --url http://app.localhost:3000/api/public/v1/funnels \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "storeId": "<string>",
  "config": {
    "name": "<string>",
    "id": "<string>",
    "description": "<string>",
    "version": "1.0.0",
    "nodes": [
      {
        "id": "<string>",
        "name": "<string>",
        "type": "<string>",
        "kind": "<string>",
        "isEntry": true,
        "isDefault": true,
        "isConversion": true,
        "config": {},
        "variants": "<array>",
        "splitType": "<string>",
        "metadata": {}
      }
    ],
    "edges": [
      {
        "id": "<string>",
        "source": "<string>",
        "target": "<string>",
        "label": "<string>",
        "conditions": "<unknown>",
        "metadata": {}
      }
    ],
    "steps": [
      {
        "id": "<string>",
        "name": "<string>",
        "type": "<string>",
        "index": 123,
        "row": 123,
        "isEntry": true,
        "isDefault": true,
        "config": {},
        "variants": [
          {
            "id": "<string>",
            "label": "<string>",
            "percentage": 123,
            "config": {}
          }
        ],
        "conditions": {}
      }
    ],
    "metadata": {}
  },
  "isDefault": true
}
'
{
  "message": "<string>",
  "code": "<string>",
  "issues": [
    {
      "message": "<string>"
    }
  ]
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
storeId
string
required
config
object
required
isDefault
boolean

Response

Successful response