Update a funnel
curl --request POST \
--url 'https://api.flashcat.cloud/rum/funnel/update?app_key=' \
--header 'Content-Type: application/json' \
--data '
{
"application_id": "app_3fK9mQ2xLp7VbN4cR8dW1y",
"definition": {
"filters": [
{
"field": "device_type",
"values": [
"desktop"
]
}
],
"steps": [
{
"kind": "page",
"label": "Cart",
"page": {
"op": "prefix",
"value": "/cart"
}
},
{
"event_id": "n3Q8kZvT2mRxW7cLpYbE4a",
"kind": "event",
"label": "Checkout"
},
{
"kind": "page",
"label": "Thank you",
"page": {
"op": "eq",
"value": "/thank-you"
}
}
],
"unit": "session"
},
"funnel_id": "p7Rt2YwX9kLm4NcV6bQa1Z",
"name": "Cart to paid order"
}
'import requests
url = "https://api.flashcat.cloud/rum/funnel/update?app_key="
payload = {
"application_id": "app_3fK9mQ2xLp7VbN4cR8dW1y",
"definition": {
"filters": [
{
"field": "device_type",
"values": ["desktop"]
}
],
"steps": [
{
"kind": "page",
"label": "Cart",
"page": {
"op": "prefix",
"value": "/cart"
}
},
{
"event_id": "n3Q8kZvT2mRxW7cLpYbE4a",
"kind": "event",
"label": "Checkout"
},
{
"kind": "page",
"label": "Thank you",
"page": {
"op": "eq",
"value": "/thank-you"
}
}
],
"unit": "session"
},
"funnel_id": "p7Rt2YwX9kLm4NcV6bQa1Z",
"name": "Cart to paid order"
}
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
application_id: 'app_3fK9mQ2xLp7VbN4cR8dW1y',
definition: {
filters: [{field: 'device_type', values: ['desktop']}],
steps: [
{kind: 'page', label: 'Cart', page: {op: 'prefix', value: '/cart'}},
{event_id: 'n3Q8kZvT2mRxW7cLpYbE4a', kind: 'event', label: 'Checkout'},
{kind: 'page', label: 'Thank you', page: {op: 'eq', value: '/thank-you'}}
],
unit: 'session'
},
funnel_id: 'p7Rt2YwX9kLm4NcV6bQa1Z',
name: 'Cart to paid order'
})
};
fetch('https://api.flashcat.cloud/rum/funnel/update?app_key=', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.flashcat.cloud/rum/funnel/update?app_key=",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'application_id' => 'app_3fK9mQ2xLp7VbN4cR8dW1y',
'definition' => [
'filters' => [
[
'field' => 'device_type',
'values' => [
'desktop'
]
]
],
'steps' => [
[
'kind' => 'page',
'label' => 'Cart',
'page' => [
'op' => 'prefix',
'value' => '/cart'
]
],
[
'event_id' => 'n3Q8kZvT2mRxW7cLpYbE4a',
'kind' => 'event',
'label' => 'Checkout'
],
[
'kind' => 'page',
'label' => 'Thank you',
'page' => [
'op' => 'eq',
'value' => '/thank-you'
]
]
],
'unit' => 'session'
],
'funnel_id' => 'p7Rt2YwX9kLm4NcV6bQa1Z',
'name' => 'Cart to paid order'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.flashcat.cloud/rum/funnel/update?app_key="
payload := strings.NewReader("{\n \"application_id\": \"app_3fK9mQ2xLp7VbN4cR8dW1y\",\n \"definition\": {\n \"filters\": [\n {\n \"field\": \"device_type\",\n \"values\": [\n \"desktop\"\n ]\n }\n ],\n \"steps\": [\n {\n \"kind\": \"page\",\n \"label\": \"Cart\",\n \"page\": {\n \"op\": \"prefix\",\n \"value\": \"/cart\"\n }\n },\n {\n \"event_id\": \"n3Q8kZvT2mRxW7cLpYbE4a\",\n \"kind\": \"event\",\n \"label\": \"Checkout\"\n },\n {\n \"kind\": \"page\",\n \"label\": \"Thank you\",\n \"page\": {\n \"op\": \"eq\",\n \"value\": \"/thank-you\"\n }\n }\n ],\n \"unit\": \"session\"\n },\n \"funnel_id\": \"p7Rt2YwX9kLm4NcV6bQa1Z\",\n \"name\": \"Cart to paid order\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.flashcat.cloud/rum/funnel/update?app_key=")
.header("Content-Type", "application/json")
.body("{\n \"application_id\": \"app_3fK9mQ2xLp7VbN4cR8dW1y\",\n \"definition\": {\n \"filters\": [\n {\n \"field\": \"device_type\",\n \"values\": [\n \"desktop\"\n ]\n }\n ],\n \"steps\": [\n {\n \"kind\": \"page\",\n \"label\": \"Cart\",\n \"page\": {\n \"op\": \"prefix\",\n \"value\": \"/cart\"\n }\n },\n {\n \"event_id\": \"n3Q8kZvT2mRxW7cLpYbE4a\",\n \"kind\": \"event\",\n \"label\": \"Checkout\"\n },\n {\n \"kind\": \"page\",\n \"label\": \"Thank you\",\n \"page\": {\n \"op\": \"eq\",\n \"value\": \"/thank-you\"\n }\n }\n ],\n \"unit\": \"session\"\n },\n \"funnel_id\": \"p7Rt2YwX9kLm4NcV6bQa1Z\",\n \"name\": \"Cart to paid order\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.flashcat.cloud/rum/funnel/update?app_key=")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"application_id\": \"app_3fK9mQ2xLp7VbN4cR8dW1y\",\n \"definition\": {\n \"filters\": [\n {\n \"field\": \"device_type\",\n \"values\": [\n \"desktop\"\n ]\n }\n ],\n \"steps\": [\n {\n \"kind\": \"page\",\n \"label\": \"Cart\",\n \"page\": {\n \"op\": \"prefix\",\n \"value\": \"/cart\"\n }\n },\n {\n \"event_id\": \"n3Q8kZvT2mRxW7cLpYbE4a\",\n \"kind\": \"event\",\n \"label\": \"Checkout\"\n },\n {\n \"kind\": \"page\",\n \"label\": \"Thank you\",\n \"page\": {\n \"op\": \"eq\",\n \"value\": \"/thank-you\"\n }\n }\n ],\n \"unit\": \"session\"\n },\n \"funnel_id\": \"p7Rt2YwX9kLm4NcV6bQa1Z\",\n \"name\": \"Cart to paid order\"\n}"
response = http.request(request)
puts response.read_body{
"data": {
"created_at": 1779331200000,
"created_by": 80011,
"definition": {
"filters": [
{
"field": "device_type",
"values": [
"desktop"
]
}
],
"steps": [
{
"kind": "page",
"label": "Cart",
"page": {
"op": "prefix",
"value": "/cart"
}
},
{
"event_id": "n3Q8kZvT2mRxW7cLpYbE4a",
"kind": "event",
"label": "Checkout"
},
{
"kind": "page",
"label": "Thank you",
"page": {
"op": "eq",
"value": "/thank-you"
}
}
],
"unit": "session"
},
"funnel_id": "p7Rt2YwX9kLm4NcV6bQa1Z",
"name": "Cart to paid order",
"updated_at": 1780359000000,
"updated_by": 80042
},
"request_id": "01HK8XQE3Z7JM2NTFQ5YJ8P9R4"
}{
"error": {
"code": "InvalidParameter",
"message": "The specified parameter is not valid."
},
"request_id": "01HK8XQE3Z7JM2NTFQ5YJ8P9R4"
}{
"error": {
"code": "Unauthorized",
"message": "You are unauthorized."
},
"request_id": "01HK8XQE3Z7JM2NTFQ5YJ8P9R4"
}{
"error": {
"code": "AccessDenied",
"message": "Access Denied."
},
"request_id": "01HK8XQE3Z7JM2NTFQ5YJ8P9R4"
}{
"error": {
"code": "RequestTooFrequently",
"message": "Request too frequently."
},
"request_id": "01HK8XQE3Z7JM2NTFQ5YJ8P9R4"
}{
"error": {
"code": "InternalError",
"message": "We encountered an internal error, and it has been reported. Please try again later."
},
"request_id": "01HK8XQE3Z7JM2NTFQ5YJ8P9R4"
}Funnels
Update a funnel
Replace a saved funnel’s name and definition.
POST
/
rum
/
funnel
/
update
Update a funnel
curl --request POST \
--url 'https://api.flashcat.cloud/rum/funnel/update?app_key=' \
--header 'Content-Type: application/json' \
--data '
{
"application_id": "app_3fK9mQ2xLp7VbN4cR8dW1y",
"definition": {
"filters": [
{
"field": "device_type",
"values": [
"desktop"
]
}
],
"steps": [
{
"kind": "page",
"label": "Cart",
"page": {
"op": "prefix",
"value": "/cart"
}
},
{
"event_id": "n3Q8kZvT2mRxW7cLpYbE4a",
"kind": "event",
"label": "Checkout"
},
{
"kind": "page",
"label": "Thank you",
"page": {
"op": "eq",
"value": "/thank-you"
}
}
],
"unit": "session"
},
"funnel_id": "p7Rt2YwX9kLm4NcV6bQa1Z",
"name": "Cart to paid order"
}
'import requests
url = "https://api.flashcat.cloud/rum/funnel/update?app_key="
payload = {
"application_id": "app_3fK9mQ2xLp7VbN4cR8dW1y",
"definition": {
"filters": [
{
"field": "device_type",
"values": ["desktop"]
}
],
"steps": [
{
"kind": "page",
"label": "Cart",
"page": {
"op": "prefix",
"value": "/cart"
}
},
{
"event_id": "n3Q8kZvT2mRxW7cLpYbE4a",
"kind": "event",
"label": "Checkout"
},
{
"kind": "page",
"label": "Thank you",
"page": {
"op": "eq",
"value": "/thank-you"
}
}
],
"unit": "session"
},
"funnel_id": "p7Rt2YwX9kLm4NcV6bQa1Z",
"name": "Cart to paid order"
}
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
application_id: 'app_3fK9mQ2xLp7VbN4cR8dW1y',
definition: {
filters: [{field: 'device_type', values: ['desktop']}],
steps: [
{kind: 'page', label: 'Cart', page: {op: 'prefix', value: '/cart'}},
{event_id: 'n3Q8kZvT2mRxW7cLpYbE4a', kind: 'event', label: 'Checkout'},
{kind: 'page', label: 'Thank you', page: {op: 'eq', value: '/thank-you'}}
],
unit: 'session'
},
funnel_id: 'p7Rt2YwX9kLm4NcV6bQa1Z',
name: 'Cart to paid order'
})
};
fetch('https://api.flashcat.cloud/rum/funnel/update?app_key=', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.flashcat.cloud/rum/funnel/update?app_key=",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'application_id' => 'app_3fK9mQ2xLp7VbN4cR8dW1y',
'definition' => [
'filters' => [
[
'field' => 'device_type',
'values' => [
'desktop'
]
]
],
'steps' => [
[
'kind' => 'page',
'label' => 'Cart',
'page' => [
'op' => 'prefix',
'value' => '/cart'
]
],
[
'event_id' => 'n3Q8kZvT2mRxW7cLpYbE4a',
'kind' => 'event',
'label' => 'Checkout'
],
[
'kind' => 'page',
'label' => 'Thank you',
'page' => [
'op' => 'eq',
'value' => '/thank-you'
]
]
],
'unit' => 'session'
],
'funnel_id' => 'p7Rt2YwX9kLm4NcV6bQa1Z',
'name' => 'Cart to paid order'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.flashcat.cloud/rum/funnel/update?app_key="
payload := strings.NewReader("{\n \"application_id\": \"app_3fK9mQ2xLp7VbN4cR8dW1y\",\n \"definition\": {\n \"filters\": [\n {\n \"field\": \"device_type\",\n \"values\": [\n \"desktop\"\n ]\n }\n ],\n \"steps\": [\n {\n \"kind\": \"page\",\n \"label\": \"Cart\",\n \"page\": {\n \"op\": \"prefix\",\n \"value\": \"/cart\"\n }\n },\n {\n \"event_id\": \"n3Q8kZvT2mRxW7cLpYbE4a\",\n \"kind\": \"event\",\n \"label\": \"Checkout\"\n },\n {\n \"kind\": \"page\",\n \"label\": \"Thank you\",\n \"page\": {\n \"op\": \"eq\",\n \"value\": \"/thank-you\"\n }\n }\n ],\n \"unit\": \"session\"\n },\n \"funnel_id\": \"p7Rt2YwX9kLm4NcV6bQa1Z\",\n \"name\": \"Cart to paid order\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.flashcat.cloud/rum/funnel/update?app_key=")
.header("Content-Type", "application/json")
.body("{\n \"application_id\": \"app_3fK9mQ2xLp7VbN4cR8dW1y\",\n \"definition\": {\n \"filters\": [\n {\n \"field\": \"device_type\",\n \"values\": [\n \"desktop\"\n ]\n }\n ],\n \"steps\": [\n {\n \"kind\": \"page\",\n \"label\": \"Cart\",\n \"page\": {\n \"op\": \"prefix\",\n \"value\": \"/cart\"\n }\n },\n {\n \"event_id\": \"n3Q8kZvT2mRxW7cLpYbE4a\",\n \"kind\": \"event\",\n \"label\": \"Checkout\"\n },\n {\n \"kind\": \"page\",\n \"label\": \"Thank you\",\n \"page\": {\n \"op\": \"eq\",\n \"value\": \"/thank-you\"\n }\n }\n ],\n \"unit\": \"session\"\n },\n \"funnel_id\": \"p7Rt2YwX9kLm4NcV6bQa1Z\",\n \"name\": \"Cart to paid order\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.flashcat.cloud/rum/funnel/update?app_key=")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"application_id\": \"app_3fK9mQ2xLp7VbN4cR8dW1y\",\n \"definition\": {\n \"filters\": [\n {\n \"field\": \"device_type\",\n \"values\": [\n \"desktop\"\n ]\n }\n ],\n \"steps\": [\n {\n \"kind\": \"page\",\n \"label\": \"Cart\",\n \"page\": {\n \"op\": \"prefix\",\n \"value\": \"/cart\"\n }\n },\n {\n \"event_id\": \"n3Q8kZvT2mRxW7cLpYbE4a\",\n \"kind\": \"event\",\n \"label\": \"Checkout\"\n },\n {\n \"kind\": \"page\",\n \"label\": \"Thank you\",\n \"page\": {\n \"op\": \"eq\",\n \"value\": \"/thank-you\"\n }\n }\n ],\n \"unit\": \"session\"\n },\n \"funnel_id\": \"p7Rt2YwX9kLm4NcV6bQa1Z\",\n \"name\": \"Cart to paid order\"\n}"
response = http.request(request)
puts response.read_body{
"data": {
"created_at": 1779331200000,
"created_by": 80011,
"definition": {
"filters": [
{
"field": "device_type",
"values": [
"desktop"
]
}
],
"steps": [
{
"kind": "page",
"label": "Cart",
"page": {
"op": "prefix",
"value": "/cart"
}
},
{
"event_id": "n3Q8kZvT2mRxW7cLpYbE4a",
"kind": "event",
"label": "Checkout"
},
{
"kind": "page",
"label": "Thank you",
"page": {
"op": "eq",
"value": "/thank-you"
}
}
],
"unit": "session"
},
"funnel_id": "p7Rt2YwX9kLm4NcV6bQa1Z",
"name": "Cart to paid order",
"updated_at": 1780359000000,
"updated_by": 80042
},
"request_id": "01HK8XQE3Z7JM2NTFQ5YJ8P9R4"
}{
"error": {
"code": "InvalidParameter",
"message": "The specified parameter is not valid."
},
"request_id": "01HK8XQE3Z7JM2NTFQ5YJ8P9R4"
}{
"error": {
"code": "Unauthorized",
"message": "You are unauthorized."
},
"request_id": "01HK8XQE3Z7JM2NTFQ5YJ8P9R4"
}{
"error": {
"code": "AccessDenied",
"message": "Access Denied."
},
"request_id": "01HK8XQE3Z7JM2NTFQ5YJ8P9R4"
}{
"error": {
"code": "RequestTooFrequently",
"message": "Request too frequently."
},
"request_id": "01HK8XQE3Z7JM2NTFQ5YJ8P9R4"
}{
"error": {
"code": "InternalError",
"message": "We encountered an internal error, and it has been reported. Please try again later."
},
"request_id": "01HK8XQE3Z7JM2NTFQ5YJ8P9R4"
}Restrictions
| Aspect | Value |
|---|---|
| Rate limits | 300 requests/minute; 20 requests/second per account |
| Permissions | Behavior Analytics Manage (rum) |
Usage
- The definition is replaced as a whole; there is no partial step update.
funnel_idis required by the handler: a call without it returnsInvalidParameter.- The call is recorded in the account audit log.
Authorizations
Body
application/json
Replace a saved funnel's name and definition.
Response
Success
Success response envelope. On every 2xx response, request_id identifies the call (also mirrored in the Flashcat-Request-Id header) and data holds the endpoint-specific payload. Failure responses use a different shape — see ErrorResponse.
Was this page helpful?