Site Studio — Funnels
6 Endpunkte. Basis-URL: https://xapi.ambertech.cloud/api/v1
List funnels for the organization (paginated)#
GET
/funnelsTokenParameter
| Name | Ort | Typ | Beschreibung |
|---|---|---|---|
page | Query | number | Page number (1-based) |
pageSize | Query | number | Items per page |
search | Query | string | Search by name or description |
published | Query | boolean | Filter by published status |
Antworten
- 200OK
Beispiel (cURL)
curl -X GET "https://xapi.ambertech.cloud/api/v1/funnels" \
-H "Authorization: Bearer $XISUITE_TOKEN"Create a funnel (auto-creates Home landing page)#
POST
/funnelsTokenRequest-Body
| Name | Typ | Beschreibung |
|---|---|---|
namePflicht | string | Funnel name |
description | object | Funnel description |
sub_domain_name | object | Subdomain (lowercase alphanumeric + hyphens, max 63 chars) |
favicon | object | Favicon URL |
template_id | string | Site template to start from (its pages, theme and form fields are copied). Omit for a blank site. |
Antworten
- 201Erstellt
Beispiel (cURL)
curl -X POST "https://xapi.ambertech.cloud/api/v1/funnels" \
-H "Authorization: Bearer $XISUITE_TOKEN" \
-H "Content-Type: application/json" \
-d '{"name":"…"}'Get a single funnel with its pages#
GET
/funnels/{funnelId}TokenParameter
| Name | Ort | Typ | Beschreibung |
|---|---|---|---|
funnelIdPflicht | Pfad | string | – |
Antworten
- 200OK
Beispiel (cURL)
curl -X GET "https://xapi.ambertech.cloud/api/v1/funnels/{funnelId}" \
-H "Authorization: Bearer $XISUITE_TOKEN"Update a funnel#
PUT
/funnels/{funnelId}TokenParameter
| Name | Ort | Typ | Beschreibung |
|---|---|---|---|
funnelIdPflicht | Pfad | string | – |
Request-Body
| Name | Typ | Beschreibung |
|---|---|---|
name | string | – |
description | object | – |
sub_domain_name | object | – |
favicon | object | – |
published | boolean | – |
live_products | LiveProductDto[] | – |
seo_title | object | – |
seo_description | object | – |
seo_image | object | – |
theme | object | Site theme configuration object |
Antworten
- 200OK
Beispiel (cURL)
curl -X PUT "https://xapi.ambertech.cloud/api/v1/funnels/{funnelId}" \
-H "Authorization: Bearer $XISUITE_TOKEN" \
-H "Content-Type: application/json" \
-d '{"name":"…","description":{},"sub_domain_name":{}}'Delete a funnel and all its associated data#
DELETE
/funnels/{funnelId}TokenParameter
| Name | Ort | Typ | Beschreibung |
|---|---|---|---|
funnelIdPflicht | Pfad | string | – |
Antworten
- 200OK
Beispiel (cURL)
curl -X DELETE "https://xapi.ambertech.cloud/api/v1/funnels/{funnelId}" \
-H "Authorization: Bearer $XISUITE_TOKEN"Publish or unpublish a funnel (cascades to all pages)#
POST
/funnels/{funnelId}/publishTokenParameter
| Name | Ort | Typ | Beschreibung |
|---|---|---|---|
funnelIdPflicht | Pfad | string | – |
Request-Body
| Name | Typ | Beschreibung |
|---|---|---|
published | boolean | Target published state. Omit to toggle current state. |
Antworten
- 200OK
Beispiel (cURL)
curl -X POST "https://xapi.ambertech.cloud/api/v1/funnels/{funnelId}/publish" \
-H "Authorization: Bearer $XISUITE_TOKEN" \
-H "Content-Type: application/json" \
-d '{"published":true}'