Documentation · API reference
POST
/api/v1/sites/{site}/funnelsAdd a funnel: its steps, in order
This page as Markdown, or in an AI chatMore ways to read this page
Add a funnel: its steps, in order.
# Add a funnel: its steps, in order
> tidekeeper's API reference: https://tidekeeper.eu/docs/api/post-sites-site-funnels
`POST /api/v1/sites/{site}/funnels`
Add a funnel: its steps, in order.
## Parameters
- `site` (in path, needed): A site's id or name
## What to send
`FunnelCreate`
- `name` (string, needed)
- `spec` (object, needed)
## The answer
201, `FunnelView`
- `id` (string, needed)
- `name` (string, needed)
- `spec` (object, needed)
- `steps` (list of string, needed): Each step in words.
## Asking
```sh
curl -X POST https://tidekeeper.eu/api/v1/sites/example.org/funnels \
-H "Authorization: Bearer $TIDEKEEPER_TOKEN" \
-H "Content-Type: application/json" \
-d '{"name": "…", "spec": {}}'
```
Parameters
- sitein the address
- neededA site's id or name
What to send
FunnelCreate
- name
- stringneeded
- spec
- objectneeded
The answer
Status 201
FunnelView
- id
- stringneeded
- name
- stringneeded
- spec
- objectneeded
- steps
- list of stringneededEach step in words.
Asking
curl -X POST https://tidekeeper.eu/api/v1/sites/example.org/funnels \ -H "Authorization: Bearer $TIDEKEEPER_TOKEN" \ -H "Content-Type: application/json" \ -d '{"name": "…", "spec": {}}'
const answer = await fetch("https://tidekeeper.eu/api/v1/sites/example.org/funnels", { method: "POST", headers: { Authorization: `Bearer ${process.env.TIDEKEEPER_TOKEN}`, "Content-Type": "application/json", }, body: JSON.stringify({"name": "…", "spec": {}}), }).then((r) => r.json());