What turning a flow on will do
curl --request GET \
--url https://api.statisfy.com/v1/automations/flows/{flow_id}/enable-preview \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.statisfy.com/v1/automations/flows/{flow_id}/enable-preview"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.statisfy.com/v1/automations/flows/{flow_id}/enable-preview', 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.statisfy.com/v1/automations/flows/{flow_id}/enable-preview",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.statisfy.com/v1/automations/flows/{flow_id}/enable-preview"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.statisfy.com/v1/automations/flows/{flow_id}/enable-preview")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.statisfy.com/v1/automations/flows/{flow_id}/enable-preview")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"can_enable": true,
"first_run": "<string>",
"last_full_test": {},
"matching_records": 123,
"per_run": [
"<string>"
],
"preview_token": "<string>",
"problems": [
"<string>"
],
"trigger": "<string>",
"examples": [
"<string>"
],
"has_run_before": false,
"is_on": false,
"last_run_at": "<string>",
"runs_so_far": 0,
"warnings": [
"<string>"
]
}automations
What turning a flow on will do
How many records match now, what the first run does, what each run sends or writes, the last full test, problems, and the token turning it on needs.
GET
/
v1
/
automations
/
flows
/
{flow_id}
/
enable-preview
What turning a flow on will do
curl --request GET \
--url https://api.statisfy.com/v1/automations/flows/{flow_id}/enable-preview \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.statisfy.com/v1/automations/flows/{flow_id}/enable-preview"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.statisfy.com/v1/automations/flows/{flow_id}/enable-preview', 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.statisfy.com/v1/automations/flows/{flow_id}/enable-preview",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.statisfy.com/v1/automations/flows/{flow_id}/enable-preview"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.statisfy.com/v1/automations/flows/{flow_id}/enable-preview")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.statisfy.com/v1/automations/flows/{flow_id}/enable-preview")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"can_enable": true,
"first_run": "<string>",
"last_full_test": {},
"matching_records": 123,
"per_run": [
"<string>"
],
"preview_token": "<string>",
"problems": [
"<string>"
],
"trigger": "<string>",
"examples": [
"<string>"
],
"has_run_before": false,
"is_on": false,
"last_run_at": "<string>",
"runs_so_far": 0,
"warnings": [
"<string>"
]
}Authorizations
An API key, sent as Authorization: Bearer stfy_live_…. See Authentication for how to get one and which scopes it needs.
Response
200 - application/json
Successful Response
Was this page helpful?