Preview an approval procedure audience
curl --request POST \
--url https://app.letsflow.ai/v1/approval_procedure_definitions/actions/preview \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"data": {
"document": {
"schemaVersion": 2,
"supportedSourceKinds": [],
"inputSchema": {
"type": "object",
"properties": {},
"additionalProperties": false,
"required": [
"<string>"
]
},
"stages": [
{
"key": "<string>",
"displayName": "<string>",
"route": {
"kind": "requester_manager"
},
"decisionPolicy": {
"denialPolicy": "deny_veto",
"approvalsRequired": 2
},
"timeout": {
"expiresAfterSeconds": 1296000,
"reminderOffsetsSeconds": [
2
]
}
}
]
},
"scenario": {
"requestedByPrincipalId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"requestedForPrincipalId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"teamId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"input": {}
}
}
}
'import requests
url = "https://app.letsflow.ai/v1/approval_procedure_definitions/actions/preview"
payload = { "data": {
"document": {
"schemaVersion": 2,
"supportedSourceKinds": [],
"inputSchema": {
"type": "object",
"properties": {},
"additionalProperties": False,
"required": ["<string>"]
},
"stages": [
{
"key": "<string>",
"displayName": "<string>",
"route": { "kind": "requester_manager" },
"decisionPolicy": {
"denialPolicy": "deny_veto",
"approvalsRequired": 2
},
"timeout": {
"expiresAfterSeconds": 1296000,
"reminderOffsetsSeconds": [2]
}
}
]
},
"scenario": {
"requestedByPrincipalId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"requestedForPrincipalId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"teamId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"input": {}
}
} }
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
data: {
document: {
schemaVersion: 2,
supportedSourceKinds: [],
inputSchema: {
type: 'object',
properties: {},
additionalProperties: false,
required: ['<string>']
},
stages: [
{
key: '<string>',
displayName: '<string>',
route: {kind: 'requester_manager'},
decisionPolicy: {denialPolicy: 'deny_veto', approvalsRequired: 2},
timeout: {expiresAfterSeconds: 1296000, reminderOffsetsSeconds: [2]}
}
]
},
scenario: {
requestedByPrincipalId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
requestedForPrincipalId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
teamId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
input: {}
}
}
})
};
fetch('https://app.letsflow.ai/v1/approval_procedure_definitions/actions/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://app.letsflow.ai/v1/approval_procedure_definitions/actions/preview",
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([
'data' => [
'document' => [
'schemaVersion' => 2,
'supportedSourceKinds' => [
],
'inputSchema' => [
'type' => 'object',
'properties' => [
],
'additionalProperties' => false,
'required' => [
'<string>'
]
],
'stages' => [
[
'key' => '<string>',
'displayName' => '<string>',
'route' => [
'kind' => 'requester_manager'
],
'decisionPolicy' => [
'denialPolicy' => 'deny_veto',
'approvalsRequired' => 2
],
'timeout' => [
'expiresAfterSeconds' => 1296000,
'reminderOffsetsSeconds' => [
2
]
]
]
]
],
'scenario' => [
'requestedByPrincipalId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'requestedForPrincipalId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'teamId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'input' => [
]
]
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"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://app.letsflow.ai/v1/approval_procedure_definitions/actions/preview"
payload := strings.NewReader("{\n \"data\": {\n \"document\": {\n \"schemaVersion\": 2,\n \"supportedSourceKinds\": [],\n \"inputSchema\": {\n \"type\": \"object\",\n \"properties\": {},\n \"additionalProperties\": false,\n \"required\": [\n \"<string>\"\n ]\n },\n \"stages\": [\n {\n \"key\": \"<string>\",\n \"displayName\": \"<string>\",\n \"route\": {\n \"kind\": \"requester_manager\"\n },\n \"decisionPolicy\": {\n \"denialPolicy\": \"deny_veto\",\n \"approvalsRequired\": 2\n },\n \"timeout\": {\n \"expiresAfterSeconds\": 1296000,\n \"reminderOffsetsSeconds\": [\n 2\n ]\n }\n }\n ]\n },\n \"scenario\": {\n \"requestedByPrincipalId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"requestedForPrincipalId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"teamId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"input\": {}\n }\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
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://app.letsflow.ai/v1/approval_procedure_definitions/actions/preview")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"data\": {\n \"document\": {\n \"schemaVersion\": 2,\n \"supportedSourceKinds\": [],\n \"inputSchema\": {\n \"type\": \"object\",\n \"properties\": {},\n \"additionalProperties\": false,\n \"required\": [\n \"<string>\"\n ]\n },\n \"stages\": [\n {\n \"key\": \"<string>\",\n \"displayName\": \"<string>\",\n \"route\": {\n \"kind\": \"requester_manager\"\n },\n \"decisionPolicy\": {\n \"denialPolicy\": \"deny_veto\",\n \"approvalsRequired\": 2\n },\n \"timeout\": {\n \"expiresAfterSeconds\": 1296000,\n \"reminderOffsetsSeconds\": [\n 2\n ]\n }\n }\n ]\n },\n \"scenario\": {\n \"requestedByPrincipalId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"requestedForPrincipalId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"teamId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"input\": {}\n }\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.letsflow.ai/v1/approval_procedure_definitions/actions/preview")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"data\": {\n \"document\": {\n \"schemaVersion\": 2,\n \"supportedSourceKinds\": [],\n \"inputSchema\": {\n \"type\": \"object\",\n \"properties\": {},\n \"additionalProperties\": false,\n \"required\": [\n \"<string>\"\n ]\n },\n \"stages\": [\n {\n \"key\": \"<string>\",\n \"displayName\": \"<string>\",\n \"route\": {\n \"kind\": \"requester_manager\"\n },\n \"decisionPolicy\": {\n \"denialPolicy\": \"deny_veto\",\n \"approvalsRequired\": 2\n },\n \"timeout\": {\n \"expiresAfterSeconds\": 1296000,\n \"reminderOffsetsSeconds\": [\n 2\n ]\n }\n }\n ]\n },\n \"scenario\": {\n \"requestedByPrincipalId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"requestedForPrincipalId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"teamId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"input\": {}\n }\n }\n}"
response = http.request(request)
puts response.read_body{
"data": {
"stages": [
{
"key": "<string>",
"order": 2,
"approvers": [
{
"principal_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"display_name": "<string>",
"primary_email": "<string>",
"provenance": {}
}
],
"audience": {
"size": 1,
"limit": 2,
"warning": "<string>"
},
"policy": {
"decision_policy": "any_one",
"approvals_required": 2,
"denial_policy": "deny_veto",
"self_approval_rule": "forbid"
}
}
]
},
"meta": {
"request_id": "<string>",
"correlation_id": "<string>",
"operation": "<string>",
"resource": "<string>"
}
}{
"type": "https://app.letsflow.ai/problems/access-grant-not-found",
"title": "<string>",
"status": 123,
"code": "access_grant_admin_extension_required",
"detail": "<string>",
"instance": "<string>",
"request_id": "<string>",
"correlation_id": "<string>",
"retryable": true,
"auth_failure_reason": "<string>",
"availability_reason": "capability_disabled",
"re_auth_required": true,
"violations": [
{
"field": "<string>",
"message": "<string>",
"capability": "<string>",
"details": {}
}
],
"diagnostics": [
{
"code": "<string>",
"severity": "info",
"message": "<string>",
"fixHint": "<string>",
"location": {
"file": "<string>",
"line": 2,
"column": 2,
"stepId": "<string>"
}
}
]
}Approval procedure definitions
Preview an approval procedure audience
Resolve every stage against an explicit scenario without publishing it.
POST
/
v1
/
approval_procedure_definitions
/
actions
/
preview
Preview an approval procedure audience
curl --request POST \
--url https://app.letsflow.ai/v1/approval_procedure_definitions/actions/preview \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"data": {
"document": {
"schemaVersion": 2,
"supportedSourceKinds": [],
"inputSchema": {
"type": "object",
"properties": {},
"additionalProperties": false,
"required": [
"<string>"
]
},
"stages": [
{
"key": "<string>",
"displayName": "<string>",
"route": {
"kind": "requester_manager"
},
"decisionPolicy": {
"denialPolicy": "deny_veto",
"approvalsRequired": 2
},
"timeout": {
"expiresAfterSeconds": 1296000,
"reminderOffsetsSeconds": [
2
]
}
}
]
},
"scenario": {
"requestedByPrincipalId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"requestedForPrincipalId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"teamId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"input": {}
}
}
}
'import requests
url = "https://app.letsflow.ai/v1/approval_procedure_definitions/actions/preview"
payload = { "data": {
"document": {
"schemaVersion": 2,
"supportedSourceKinds": [],
"inputSchema": {
"type": "object",
"properties": {},
"additionalProperties": False,
"required": ["<string>"]
},
"stages": [
{
"key": "<string>",
"displayName": "<string>",
"route": { "kind": "requester_manager" },
"decisionPolicy": {
"denialPolicy": "deny_veto",
"approvalsRequired": 2
},
"timeout": {
"expiresAfterSeconds": 1296000,
"reminderOffsetsSeconds": [2]
}
}
]
},
"scenario": {
"requestedByPrincipalId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"requestedForPrincipalId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"teamId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"input": {}
}
} }
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
data: {
document: {
schemaVersion: 2,
supportedSourceKinds: [],
inputSchema: {
type: 'object',
properties: {},
additionalProperties: false,
required: ['<string>']
},
stages: [
{
key: '<string>',
displayName: '<string>',
route: {kind: 'requester_manager'},
decisionPolicy: {denialPolicy: 'deny_veto', approvalsRequired: 2},
timeout: {expiresAfterSeconds: 1296000, reminderOffsetsSeconds: [2]}
}
]
},
scenario: {
requestedByPrincipalId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
requestedForPrincipalId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
teamId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
input: {}
}
}
})
};
fetch('https://app.letsflow.ai/v1/approval_procedure_definitions/actions/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://app.letsflow.ai/v1/approval_procedure_definitions/actions/preview",
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([
'data' => [
'document' => [
'schemaVersion' => 2,
'supportedSourceKinds' => [
],
'inputSchema' => [
'type' => 'object',
'properties' => [
],
'additionalProperties' => false,
'required' => [
'<string>'
]
],
'stages' => [
[
'key' => '<string>',
'displayName' => '<string>',
'route' => [
'kind' => 'requester_manager'
],
'decisionPolicy' => [
'denialPolicy' => 'deny_veto',
'approvalsRequired' => 2
],
'timeout' => [
'expiresAfterSeconds' => 1296000,
'reminderOffsetsSeconds' => [
2
]
]
]
]
],
'scenario' => [
'requestedByPrincipalId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'requestedForPrincipalId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'teamId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'input' => [
]
]
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"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://app.letsflow.ai/v1/approval_procedure_definitions/actions/preview"
payload := strings.NewReader("{\n \"data\": {\n \"document\": {\n \"schemaVersion\": 2,\n \"supportedSourceKinds\": [],\n \"inputSchema\": {\n \"type\": \"object\",\n \"properties\": {},\n \"additionalProperties\": false,\n \"required\": [\n \"<string>\"\n ]\n },\n \"stages\": [\n {\n \"key\": \"<string>\",\n \"displayName\": \"<string>\",\n \"route\": {\n \"kind\": \"requester_manager\"\n },\n \"decisionPolicy\": {\n \"denialPolicy\": \"deny_veto\",\n \"approvalsRequired\": 2\n },\n \"timeout\": {\n \"expiresAfterSeconds\": 1296000,\n \"reminderOffsetsSeconds\": [\n 2\n ]\n }\n }\n ]\n },\n \"scenario\": {\n \"requestedByPrincipalId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"requestedForPrincipalId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"teamId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"input\": {}\n }\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
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://app.letsflow.ai/v1/approval_procedure_definitions/actions/preview")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"data\": {\n \"document\": {\n \"schemaVersion\": 2,\n \"supportedSourceKinds\": [],\n \"inputSchema\": {\n \"type\": \"object\",\n \"properties\": {},\n \"additionalProperties\": false,\n \"required\": [\n \"<string>\"\n ]\n },\n \"stages\": [\n {\n \"key\": \"<string>\",\n \"displayName\": \"<string>\",\n \"route\": {\n \"kind\": \"requester_manager\"\n },\n \"decisionPolicy\": {\n \"denialPolicy\": \"deny_veto\",\n \"approvalsRequired\": 2\n },\n \"timeout\": {\n \"expiresAfterSeconds\": 1296000,\n \"reminderOffsetsSeconds\": [\n 2\n ]\n }\n }\n ]\n },\n \"scenario\": {\n \"requestedByPrincipalId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"requestedForPrincipalId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"teamId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"input\": {}\n }\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.letsflow.ai/v1/approval_procedure_definitions/actions/preview")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"data\": {\n \"document\": {\n \"schemaVersion\": 2,\n \"supportedSourceKinds\": [],\n \"inputSchema\": {\n \"type\": \"object\",\n \"properties\": {},\n \"additionalProperties\": false,\n \"required\": [\n \"<string>\"\n ]\n },\n \"stages\": [\n {\n \"key\": \"<string>\",\n \"displayName\": \"<string>\",\n \"route\": {\n \"kind\": \"requester_manager\"\n },\n \"decisionPolicy\": {\n \"denialPolicy\": \"deny_veto\",\n \"approvalsRequired\": 2\n },\n \"timeout\": {\n \"expiresAfterSeconds\": 1296000,\n \"reminderOffsetsSeconds\": [\n 2\n ]\n }\n }\n ]\n },\n \"scenario\": {\n \"requestedByPrincipalId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"requestedForPrincipalId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"teamId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"input\": {}\n }\n }\n}"
response = http.request(request)
puts response.read_body{
"data": {
"stages": [
{
"key": "<string>",
"order": 2,
"approvers": [
{
"principal_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"display_name": "<string>",
"primary_email": "<string>",
"provenance": {}
}
],
"audience": {
"size": 1,
"limit": 2,
"warning": "<string>"
},
"policy": {
"decision_policy": "any_one",
"approvals_required": 2,
"denial_policy": "deny_veto",
"self_approval_rule": "forbid"
}
}
]
},
"meta": {
"request_id": "<string>",
"correlation_id": "<string>",
"operation": "<string>",
"resource": "<string>"
}
}{
"type": "https://app.letsflow.ai/problems/access-grant-not-found",
"title": "<string>",
"status": 123,
"code": "access_grant_admin_extension_required",
"detail": "<string>",
"instance": "<string>",
"request_id": "<string>",
"correlation_id": "<string>",
"retryable": true,
"auth_failure_reason": "<string>",
"availability_reason": "capability_disabled",
"re_auth_required": true,
"violations": [
{
"field": "<string>",
"message": "<string>",
"capability": "<string>",
"details": {}
}
],
"diagnostics": [
{
"code": "<string>",
"severity": "info",
"message": "<string>",
"fixHint": "<string>",
"location": {
"file": "<string>",
"line": 2,
"column": 2,
"stepId": "<string>"
}
}
]
}Authorizations
OAuth Bearer access tokens or Flow API keys with the required Flow scope families for the route.
Body
application/json
Show child attributes
Show child attributes