WhatsApp Flows
Create flow
Create a new WhatsApp Flow. By default creates a draft flow with a basic welcome screen.
POST
/
whatsapp
/
flows
Create flow
curl --request POST \
--url https://api.kapso.ai/platform/v1/whatsapp/flows \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"phone_number_id": "<string>",
"name": "<string>",
"flow_json": {},
"publish": false
}
'import requests
url = "https://api.kapso.ai/platform/v1/whatsapp/flows"
payload = {
"phone_number_id": "<string>",
"name": "<string>",
"flow_json": {},
"publish": False
}
headers = {
"X-API-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({phone_number_id: '<string>', name: '<string>', flow_json: {}, publish: false})
};
fetch('https://api.kapso.ai/platform/v1/whatsapp/flows', 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.kapso.ai/platform/v1/whatsapp/flows",
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([
'phone_number_id' => '<string>',
'name' => '<string>',
'flow_json' => [
],
'publish' => false
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-API-Key: <api-key>"
],
]);
$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.kapso.ai/platform/v1/whatsapp/flows"
payload := strings.NewReader("{\n \"phone_number_id\": \"<string>\",\n \"name\": \"<string>\",\n \"flow_json\": {},\n \"publish\": false\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-API-Key", "<api-key>")
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.kapso.ai/platform/v1/whatsapp/flows")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"phone_number_id\": \"<string>\",\n \"name\": \"<string>\",\n \"flow_json\": {},\n \"publish\": false\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.kapso.ai/platform/v1/whatsapp/flows")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"phone_number_id\": \"<string>\",\n \"name\": \"<string>\",\n \"flow_json\": {},\n \"publish\": false\n}"
response = http.request(request)
puts response.read_body{
"data": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"meta_flow_id": "<string>",
"name": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"json_version": "<string>",
"data_api_version": "<string>",
"business_account_id": "<string>",
"preview_url": "<string>",
"published_at": "2023-11-07T05:31:56Z",
"last_synced_at": "2023-11-07T05:31:56Z",
"data_endpoint_function_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"phone_number_id": "<string>",
"data_endpoint_url": "<string>",
"has_data_endpoint": true,
"flows_encryption_configured": true
}
}{
"error": "<string>"
}{
"error": "<string>"
}{
"error": "<string>"
}{
"error": "<string>"
}Authorizations
Body
application/json
Response
Flow created
Show child attributes
Show child attributes
Was this page helpful?
⌘I
Create flow
curl --request POST \
--url https://api.kapso.ai/platform/v1/whatsapp/flows \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"phone_number_id": "<string>",
"name": "<string>",
"flow_json": {},
"publish": false
}
'import requests
url = "https://api.kapso.ai/platform/v1/whatsapp/flows"
payload = {
"phone_number_id": "<string>",
"name": "<string>",
"flow_json": {},
"publish": False
}
headers = {
"X-API-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({phone_number_id: '<string>', name: '<string>', flow_json: {}, publish: false})
};
fetch('https://api.kapso.ai/platform/v1/whatsapp/flows', 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.kapso.ai/platform/v1/whatsapp/flows",
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([
'phone_number_id' => '<string>',
'name' => '<string>',
'flow_json' => [
],
'publish' => false
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-API-Key: <api-key>"
],
]);
$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.kapso.ai/platform/v1/whatsapp/flows"
payload := strings.NewReader("{\n \"phone_number_id\": \"<string>\",\n \"name\": \"<string>\",\n \"flow_json\": {},\n \"publish\": false\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-API-Key", "<api-key>")
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.kapso.ai/platform/v1/whatsapp/flows")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"phone_number_id\": \"<string>\",\n \"name\": \"<string>\",\n \"flow_json\": {},\n \"publish\": false\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.kapso.ai/platform/v1/whatsapp/flows")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"phone_number_id\": \"<string>\",\n \"name\": \"<string>\",\n \"flow_json\": {},\n \"publish\": false\n}"
response = http.request(request)
puts response.read_body{
"data": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"meta_flow_id": "<string>",
"name": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"json_version": "<string>",
"data_api_version": "<string>",
"business_account_id": "<string>",
"preview_url": "<string>",
"published_at": "2023-11-07T05:31:56Z",
"last_synced_at": "2023-11-07T05:31:56Z",
"data_endpoint_function_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"phone_number_id": "<string>",
"data_endpoint_url": "<string>",
"has_data_endpoint": true,
"flows_encryption_configured": true
}
}{
"error": "<string>"
}{
"error": "<string>"
}{
"error": "<string>"
}{
"error": "<string>"
}
