Bulk update a number of existing flows

PATCH

https://api.flowmate.ai/flows/bulk

Each object in the body must contain an id property to match it to the flow to be updated. Requires the 'flows.write' permission.

Request

Authorization

Bearer Token

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Body Params application/json

Example

[
    {
        "name": "Example flow",
        "description": "This flow polls items from a source system and processes them with a code component.",
        "tenant": "string",
        "graph": {
            "nodes": [
                [
                    {
                        "id": "step_1",
                        "componentId": "string",
                        "name": "Example adapter",
                        "function": "getItemsPolling",
                        "description": "Polls items from the source system"
                    },
                    {
                        "id": "step_2",
                        "componentId": "string",
                        "name": "Code component",
                        "function": "execute",
                        "description": "",
                        "fields": {
                            "code": "function* run() {console.log('Hello from the code component');yield msg;}"
                        }
                    }
                ]
            ],
            "edges": [
                {
                    "id": "string",
                    "config": {
                        "condition": "string",
                        "mapper": {}
                    },
                    "source": "step_1",
                    "target": "step_2"
                }
            ]
        },
        "type": "ordinary",
        "cron": "*/5 * * * *",
        "owners": [
            {
                "id": "string",
                "type": "string"
            }
        ]
    }
]

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request PATCH 'https://api.flowmate.ai/flows/bulk' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '[
    {
        "name": "Example flow",
        "description": "This flow polls items from a source system and processes them with a code component.",
        "tenant": "string",
        "graph": {
            "nodes": [
                [
                    {
                        "id": "step_1",
                        "componentId": "string",
                        "name": "Example adapter",
                        "function": "getItemsPolling",
                        "description": "Polls items from the source system"
                    },
                    {
                        "id": "step_2",
                        "componentId": "string",
                        "name": "Code component",
                        "function": "execute",
                        "description": "",
                        "fields": {
                            "code": "function* run() {console.log('\''Hello from the code component'\'');yield msg;}"
                        }
                    }
                ]
            ],
            "edges": [
                {
                    "id": "string",
                    "config": {
                        "condition": "string",
                        "mapper": {}
                    },
                    "source": "step_1",
                    "target": "step_2"
                }
            ]
        },
        "type": "ordinary",
        "cron": "*/5 * * * *",
        "owners": [
            {
                "id": "string",
                "type": "string"
            }
        ]
    }
]'

Responses

🟢200

application/json

The updated Flow.

Bodyapplication/json

Example

{
    "data": [
        {
            "name": "Example flow",
            "description": "This flow polls items from a source system and processes them with a code component.",
            "tenant": "string",
            "graph": {
                "nodes": [
                    [
                        {
                            "id": "step_1",
                            "componentId": "string",
                            "name": "Example adapter",
                            "function": "getItemsPolling",
                            "description": "Polls items from the source system"
                        },
                        {
                            "id": "step_2",
                            "componentId": "string",
                            "name": "Code component",
                            "function": "execute",
                            "description": "",
                            "fields": {
                                "code": "function* run() {console.log('Hello from the code component');yield msg;}"
                            }
                        }
                    ]
                ],
                "edges": [
                    {
                        "id": "string",
                        "config": {
                            "condition": "string",
                            "mapper": {}
                        },
                        "source": "step_1",
                        "target": "step_2"
                    }
                ]
            },
            "type": "ordinary",
            "cron": "*/5 * * * *",
            "owners": [
                {
                    "id": "string",
                    "type": "string"
                }
            ],
            "id": "string",
            "status": "active",
            "createdAt": "2019-07-30T12:52:45.957Z",
            "updatedAt": "2019-07-30T12:52:45.957Z"
        }
    ],
    "meta": {}
}

🟠404

🟠409

Modified at 2026-10-30 08:52:16

Update an existing flow

Start a flow