Skip to main content
PUT
/
api
/
public
/
v1
/
funnels
/
{funnelId}
Update funnel with routing
curl --request PUT \
  --url http://app.localhost:3000/api/public/v1/funnels/{funnelId} \
  --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": "step",
        "isEntry": true,
        "isDefault": true,
        "isConversion": true,
        "index": 123,
        "row": 123,
        "config": {
          "pluginId": "<string>",
          "instanceId": "<string>",
          "instanceVersion": "<string>",
          "variant": "<string>",
          "mountPointId": "<string>",
          "routeId": "<string>",
          "pagePath": "<string>",
          "path": "<string>",
          "url": "<string>",
          "stepConfig": {
            "payment": {
              "paymentFlowId": "<string>"
            },
            "staticResources": {},
            "scripts": [
              {
                "name": "<string>",
                "enabled": true,
                "content": "<string>"
              }
            ],
            "pixels": {},
            "paymentSetupConfig": {},
            "shippingRateSettings": {
              "hiddenShippingRateIds": [
                "<string>"
              ]
            },
            "addressSettings": {
              "countryAllowlist": [
                "<string>"
              ],
              "forcedCountry": "<string>"
            },
            "paymentSettings": {
              "methods": {},
              "translations": {}
            },
            "resources": {}
          },
          "paymentFlowId": "<string>",
          "metadata": {}
        },
        "variants": [
          {
            "id": "<string>",
            "label": "<string>",
            "percentage": 50,
            "config": {
              "pluginId": "<string>",
              "instanceId": "<string>",
              "instanceVersion": "<string>",
              "variant": "<string>",
              "mountPointId": "<string>",
              "routeId": "<string>",
              "pagePath": "<string>",
              "path": "<string>",
              "url": "<string>",
              "stepConfig": {
                "payment": {
                  "paymentFlowId": "<string>"
                },
                "staticResources": {},
                "scripts": [
                  {
                    "name": "<string>",
                    "enabled": true,
                    "content": "<string>"
                  }
                ],
                "pixels": {},
                "paymentSetupConfig": {},
                "shippingRateSettings": {
                  "hiddenShippingRateIds": [
                    "<string>"
                  ]
                },
                "addressSettings": {
                  "countryAllowlist": [
                    "<string>"
                  ],
                  "forcedCountry": "<string>"
                },
                "paymentSettings": {
                  "methods": {},
                  "translations": {}
                },
                "resources": {}
              },
              "paymentFlowId": "<string>",
              "metadata": {}
            },
            "regions": [
              "<string>"
            ]
          }
        ],
        "metadata": {}
      }
    ],
    "edges": [
      {
        "id": "<string>",
        "source": "<string>",
        "target": "<string>",
        "label": "<string>",
        "conditions": {
          "when": "<string>",
          "priority": 123,
          "bypassTo": "<string>"
        },
        "metadata": {}
      }
    ],
    "steps": [
      {
        "id": "<string>",
        "name": "<string>",
        "type": "<string>",
        "kind": "step",
        "isEntry": true,
        "isDefault": true,
        "isConversion": true,
        "index": 123,
        "row": 123,
        "config": {
          "pluginId": "<string>",
          "instanceId": "<string>",
          "instanceVersion": "<string>",
          "variant": "<string>",
          "mountPointId": "<string>",
          "routeId": "<string>",
          "pagePath": "<string>",
          "path": "<string>",
          "url": "<string>",
          "stepConfig": {
            "payment": {
              "paymentFlowId": "<string>"
            },
            "staticResources": {},
            "scripts": [
              {
                "name": "<string>",
                "enabled": true,
                "content": "<string>"
              }
            ],
            "pixels": {},
            "paymentSetupConfig": {},
            "shippingRateSettings": {
              "hiddenShippingRateIds": [
                "<string>"
              ]
            },
            "addressSettings": {
              "countryAllowlist": [
                "<string>"
              ],
              "forcedCountry": "<string>"
            },
            "paymentSettings": {
              "methods": {},
              "translations": {}
            },
            "resources": {}
          },
          "paymentFlowId": "<string>",
          "metadata": {}
        },
        "variants": [
          {
            "id": "<string>",
            "label": "<string>",
            "percentage": 50,
            "config": {
              "pluginId": "<string>",
              "instanceId": "<string>",
              "instanceVersion": "<string>",
              "variant": "<string>",
              "mountPointId": "<string>",
              "routeId": "<string>",
              "pagePath": "<string>",
              "path": "<string>",
              "url": "<string>",
              "stepConfig": {
                "payment": {
                  "paymentFlowId": "<string>"
                },
                "staticResources": {},
                "scripts": [
                  {
                    "name": "<string>",
                    "enabled": true,
                    "content": "<string>"
                  }
                ],
                "pixels": {},
                "paymentSetupConfig": {},
                "shippingRateSettings": {
                  "hiddenShippingRateIds": [
                    "<string>"
                  ]
                },
                "addressSettings": {
                  "countryAllowlist": [
                    "<string>"
                  ],
                  "forcedCountry": "<string>"
                },
                "paymentSettings": {
                  "methods": {},
                  "translations": {}
                },
                "resources": {}
              },
              "paymentFlowId": "<string>",
              "metadata": {}
            },
            "regions": [
              "<string>"
            ]
          }
        ],
        "metadata": {}
      }
    ],
    "routing": {},
    "metadata": {}
  },
  "isDefault": true,
  "active": true,
  "force": 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.

Path Parameters

funnelId
string
required

Body

application/json
storeId
string
required
config
object
required
isDefault
boolean
active
boolean
force
boolean

Response

Successful response