Update a flow

Updates an existing flow’s details and optionally its definition

PATCH /flows/{flow_id}

Update a flow

cURL

curl --request PATCH \
  --url https://app.kapso.ai/api/v1/flows/{flow_id} \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "flow": {
    "name": "Updated Flow Name",
    "description": "Updated flow description",
    "definition": {
      "nodes": [
        {
          "id": "start_node_1",
          "position": {
            "x": 100,
            "y": 200
          },
          "data": {
            "node_type": "start",
            "config": {}
          }
        }
      ],
      "edges": [
        {
          "source": "start_node_1",
          "target": "send_text_1",
          "id": "edge_1",
          "label": "next",
          "flow_condition_id": "<string>"
        }
      ]
    }
  }
}
'

import requests

url = "https://app.kapso.ai/api/v1/flows/{flow_id}"

payload = { "flow": {
        "name": "Updated Flow Name",
        "description": "Updated flow description",
        "definition": {
            "nodes": [
                {
                    "id": "start_node_1",
                    "position": {
                        "x": 100,
                        "y": 200
                    },
                    "data": {
                        "node_type": "start",
                        "config": {}
                    }
                }
            ],
            "edges": [
                {
                    "source": "start_node_1",
                    "target": "send_text_1",
                    "id": "edge_1",
                    "label": "next",
                    "flow_condition_id": "<string>"
                }
            ]
        }
    } }
headers = {
    "X-API-Key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PATCH',
  headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    flow: {
      name: 'Updated Flow Name',
      description: 'Updated flow description',
      definition: {
        nodes: [
          {
            id: 'start_node_1',
            position: {x: 100, y: 200},
            data: {node_type: 'start', config: {}}
          }
        ],
        edges: [
          {
            source: 'start_node_1',
            target: 'send_text_1',
            id: 'edge_1',
            label: 'next',
            flow_condition_id: '<string>'
          }
        ]
      }
    }
  })
};

fetch('https://app.kapso.ai/api/v1/flows/{flow_id}', 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.kapso.ai/api/v1/flows/{flow_id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'flow' => [
        'name' => 'Updated Flow Name',
        'description' => 'Updated flow description',
        'definition' => [
                'nodes' => [
                                [
                                                                'id' => 'start_node_1',
                                                                'position' => [
                                                                                                                                'x' => 100,
                                                                                                                                'y' => 200
                                                                ],
                                                                'data' => [
                                                                                                                                'node_type' => 'start',
                                                                                                                                'config' => [
                                                                                                                                                                                                                                                                
                                                                                                                                ]
                                                                ]
                                ]
                ],
                'edges' => [
                                [
                                                                'source' => 'start_node_1',
                                                                'target' => 'send_text_1',
                                                                'id' => 'edge_1',
                                                                'label' => 'next',
                                                                'flow_condition_id' => '<string>'
                                ]
                ]
        ]
    ]
  ]),
  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://app.kapso.ai/api/v1/flows/{flow_id}"

	payload := strings.NewReader("{\n  \"flow\": {\n    \"name\": \"Updated Flow Name\",\n    \"description\": \"Updated flow description\",\n    \"definition\": {\n      \"nodes\": [\n        {\n          \"id\": \"start_node_1\",\n          \"position\": {\n            \"x\": 100,\n            \"y\": 200\n          },\n          \"data\": {\n            \"node_type\": \"start\",\n            \"config\": {}\n          }\n        }\n      ],\n      \"edges\": [\n        {\n          \"source\": \"start_node_1\",\n          \"target\": \"send_text_1\",\n          \"id\": \"edge_1\",\n          \"label\": \"next\",\n          \"flow_condition_id\": \"<string>\"\n        }\n      ]\n    }\n  }\n}")

	req, _ := http.NewRequest("PATCH", 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.patch("https://app.kapso.ai/api/v1/flows/{flow_id}")
  .header("X-API-Key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"flow\": {\n    \"name\": \"Updated Flow Name\",\n    \"description\": \"Updated flow description\",\n    \"definition\": {\n      \"nodes\": [\n        {\n          \"id\": \"start_node_1\",\n          \"position\": {\n            \"x\": 100,\n            \"y\": 200\n          },\n          \"data\": {\n            \"node_type\": \"start\",\n            \"config\": {}\n          }\n        }\n      ],\n      \"edges\": [\n        {\n          \"source\": \"start_node_1\",\n          \"target\": \"send_text_1\",\n          \"id\": \"edge_1\",\n          \"label\": \"next\",\n          \"flow_condition_id\": \"<string>\"\n        }\n      ]\n    }\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://app.kapso.ai/api/v1/flows/{flow_id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"flow\": {\n    \"name\": \"Updated Flow Name\",\n    \"description\": \"Updated flow description\",\n    \"definition\": {\n      \"nodes\": [\n        {\n          \"id\": \"start_node_1\",\n          \"position\": {\n            \"x\": 100,\n            \"y\": 200\n          },\n          \"data\": {\n            \"node_type\": \"start\",\n            \"config\": {}\n          }\n        }\n      ],\n      \"edges\": [\n        {\n          \"source\": \"start_node_1\",\n          \"target\": \"send_text_1\",\n          \"id\": \"edge_1\",\n          \"label\": \"next\",\n          \"flow_condition_id\": \"<string>\"\n        }\n      ]\n    }\n  }\n}"

response = http.request(request)
puts response.read_body

200

{
  "data": {
    "id": "flow-123abc",
    "name": "Customer Onboarding Flow",
    "description": "Automated flow for onboarding new customers",
    "status": "active",
    "project_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z",
    "created_by": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>"
    },
    "last_executed_at": "2023-11-07T05:31:56Z",
    "execution_count": 42
  }
}

{
  "error": "Resource not found",
  "status": 404,
  "message": "The requested resource could not be found"
}

{
  "error": "Resource not found",
  "status": 404,
  "message": "The requested resource could not be found"
}

{
  "error": "Resource not found",
  "status": 404,
  "message": "The requested resource could not be found"
}

Authorizations

X-API-Key · string · header · required

API key required for all endpoints

Path Parameters

flow_id · string<uuid> · required

Body

application/json

flow · object · required

Show child attributes

Response

200

application/json

Flow updated successfully

data · object

Show child attributes