Create a Workflow

Developing

Local

https://localhost

POST

/api/v1/workflows

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

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

Header Params

Body Params application/json

Examples

Responses

🟢201Created

application/json

Body

Request Example

Shell

JavaScript

Java

Swift

curl --location --request POST 'https://localhost/api/v1/workflows' \
--header 'X-Multiplai-Authorization;' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "workspace_uuid": "550e8400-e29b-41d4-a716-446655440000",
    "name": "Customer Onboarding Workflow",
    "description": "Automates the customer onboarding process including welcome emails and account setup",
    "profile_photo_key": "workflow_avatar_123.png",
    "profile_photo_config": {
        "emoji": "🔄",
        "background_color": "#3B82F6",
        "preference": "emoji"
    },
    "visibility": "public",
    "is_active": true,
    "nodes": [
        {
            "id": "node_1",
            "type": "trigger",
            "position": {
                "x": 100,
                "y": 100
            },
            "data": {
                "label": "Start"
            }
        }
    ],
    "edges": [
        {
            "id": "edge_1",
            "source": "node_1",
            "target": "node_2",
            "type": "default"
        }
    ],
    "settings": {
        "timeout": 3600,
        "retry_policy": "exponential_backoff",
        "max_retries": 3
    },
    "static_data": {
        "api_endpoints": {
            "crm": "https://api.crm.example.com",
            "email": "https://api.email.example.com"
        }
    },
    "pin_data": {
        "node_1": {
            "output": {
                "user_id": 123,
                "email": "test@example.com"
            }
        }
    },
    "metadata": {
        "tags": [
            "onboarding",
            "automation"
        ],
        "category": "customer_management",
        "version": "1.0.0"
    }
}'

Response Example

{
    "data": {
        "id": 42,
        "uuid": "550e8400-e29b-41d4-a716-446655440000",
        "user_id": 15,
        "workspace_id": 3,
        "template_id": null,
        "name": "Customer Onboarding Flow",
        "description": "Automated workflow for onboarding new customers",
        "profile_photo_url": null,
        "profile_photo_config": null,
        "visibility": "workspace",
        "is_active": true,
        "is_owner": true,
        "is_favorite": false,
        "trigger_count": 2,
        "allow_cloning": true,
        "allow_account_usage": false,
        "last_used_at": "2026-02-10T14:30:00.000000Z",
        "created_at": "2026-01-15T10:00:00.000000Z",
        "updated_at": "2026-02-10T09:15:00.000000Z",
        "deleted_at": null,
        "executions_count": 156,
        "executions_in_progress_count": 3,
        "executions_for_review_count": 7,
        "executions_completed_count": 142
    }
}

Modified at 2025-06-20 03:45:17

Get Workflows

Retrieve a Workflow