Funnel Groups
Required feature: **funnels/*/view**
Section:
Group Funnel Groups. Base URL:https://instance_name.meiro.io/api/.
Funnel Group [/funnel_groups/{funnel_group_id}]
Retrieve Funnel Group [GET]
Required feature: funnels/*/view
-
Request (application/json)
-
Headers
X-Access-Token: 1234567890abcdef
-
-
Response 200 (application/json)
{
"funnel_group": {
"id": "ba280b31-ba06-442d-ba1f-2c0dde5a691c",
"name": "My Funnel Group",
"created": "2023-10-24T07:12:49.323395Z",
"modified": "2023-10-24T07:12:49.323395Z",
"modified_by": 3,
"disabled": false,
"deleted": false,
"order_index": 1
}
}Modify Funnel Group [PATCH]
Required feature: funnels/*/edit
-
Attributes (FunnelGroupUpdate)
-
Request (application/json)
-
Headers
X-Access-Token: 1234567890abcdef
-
-
Response 200 (application/json)
{
"funnel_group": {
"id": "ba280b31-ba06-442d-ba1f-2c0dde5a691c",
"name": "My Updated Funnel Group",
"created": "2023-10-24T07:12:49.323395Z",
"modified": "2023-10-24T07:12:49.323395Z",
"modified_by": 3,
"disabled": false,
"deleted": false,
"order_index": 1
}
}Delete Funnel Group [DELETE]
Required feature: funnels/*/edit
-
Request (application/json)
-
Headers
X-Access-Token: 1234567890abcdef
-
-
Response 200 (application/json)
{
"message": "OK"
}
Funnel Groups [/funnel_groups]
List All Funnel Groups [GET]
Required feature: funnels/*/view
-
Request (application/json)
-
Headers
X-Access-Token: 1234567890abcdef
-
-
Response 200 (application/json)
{
"funnel_groups": [
{
"id": "ba280b31-ba06-442d-ba1f-2c0dde5a691c",
"name": "My Funnel Group",
"created": "2023-10-24T07:12:49.323395Z",
"modified": "2023-10-24T07:12:49.323395Z",
"modified_by": 3,
"disabled": false,
"deleted": false,
"order_index": 1
}
]
}Create Funnel Group [POST]
Required feature: settings/funnel_groups
-
Attributes (FunnelGroupCreate)
-
Request (application/json)
-
Headers
X-Access-Token: 1234567890abcdef
-
-
Response 201 (application/json)
{
"funnel_group": {
"id": "ba280b31-ba06-442d-ba1f-2c0dde5a691c",
"name": "My Funnel Group",
"created": "2023-10-24T07:12:49.323395Z",
"modified": "2023-10-24T07:12:49.323395Z",
"modified_by": 3,
"disabled": false,
"deleted": false,
"order_index": 1
}
}Funnel Groups Move [/funnel_groups/{funnel_group_id}/move]
Move Funnel Group [PATCH]
Required feature: funnels/*/edit
-
Attributes (FunnelGroupMove)
-
Request (application/json)
-
Headers
X-Access-Token: 1234567890abcdef
-
-
Response 200 (application/json)
{
"message": "OK"
}
Trashed Funnel Groups [/funnel_groups/trash]
List All Trashed Funnel Groups [GET]
Required feature: funnels/*/view
-
Request (application/json)
-
Headers
X-Access-Token: 1234567890abcdef
-
-
Response 200 (application/json)
{
"trashed_funnel_groups": [
{
"id": "ba280b31-ba06-442d-ba1f-2c0dde5a691c",
"name": "My Funnel Group",
"created": "2023-10-24T07:12:49.323395Z",
"modified": "2023-10-24T07:12:49.323395Z",
"modified_by": 3,
"disabled": false,
"deleted": false,
"order_index": 1
}
]
}Trashed Funnel Group [/funnel_groups/{funnel_group_id}/trash]
Restore Trashed Funnel Group [PATCH]
Required feature: funnels/*/edit
-
Request (application/json)
-
Headers
X-Access-Token: 1234567890abcdef
-
-
Response 200 (application/json)
{
"funnel_group": {
"id": "ba280b31-ba06-442d-ba1f-2c0dde5a691c",
"name": "My Funnel Group",
"created": "2023-10-24T07:12:49.323395Z",
"modified": "2023-10-24T07:12:49.323395Z",
"modified_by": 3,
"disabled": false,
"deleted": false,
"order_index": 1
}
}