Create Workflow

POST

/v1/workflows

Create a workflow in the account from a definition you supply.

Pass a name, plus definition_version and definition. Build the definition out of the actions and triggers returned by Retrieve Workflow Action Definitions and Retrieve Workflow Trigger Definitions.

To start from a ready-made definition instead, take one from Retrieve Workflow Templates and replace its {{variables.<name>}} placeholders with the values for your account.

The workflow is always created disabled, and its definition is stored as sent without being validated — an incomplete or draft definition is accepted. Nothing runs until you enable it through Update Workflow, which is where the definition is validated.

Credit Note: Creating a workflow does not consume credits.

INFO

Requires the workflows:write OAuth2 scope.

Request

Authorization

API Key

Add parameter in header

X-Api-Key

Example:

X-Api-Key: ********************

Query Params

Body Params application/jsonRequired

Examples

A complete definitionAn incomplete definition, to be filled in later

{
    "data": {
        "type": "workflow",
        "attributes": {
            "name": "Route hot leads to Slack",
            "description": "Notifies #sales whenever a company lands on the Hot Leads list.",
            "definition_version": "V1",
            "definition": {
                "triggers": [
                    {
                        "name": "company_added_to_list",
                        "filters": [
                            {
                                "attribute": "list_id",
                                "op": "eq",
                                "value": "42"
                            }
                        ]
                    }
                ],
                "steps": {
                    "notify_sales": {
                        "action_name": "send_company_to_slack",
                        "options": {
                            "channel": "#sales"
                        }
                    }
                },
                "order": {
                    "trigger": [
                        "notify_sales"
                    ]
                }
            }
        }
    }
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

cURL

A complete definitionAn incomplete definition, to be filled in later

curl --location 'https://api.leadfeeder.com/v1/workflows?account_id=123456' \
--header 'X-Api-Key: <api-key>' \
--header 'Content-Type: application/json' \
--data '{
    "data": {
        "type": "workflow",
        "attributes": {
            "name": "Route hot leads to Slack",
            "description": "Notifies #sales whenever a company lands on the Hot Leads list.",
            "definition_version": "V1",
            "definition": {
                "triggers": [
                    {
                        "name": "company_added_to_list",
                        "filters": [
                            {
                                "attribute": "list_id",
                                "op": "eq",
                                "value": "42"
                            }
                        ]
                    }
                ],
                "steps": {
                    "notify_sales": {
                        "action_name": "send_company_to_slack",
                        "options": {
                            "channel": "#sales"
                        }
                    }
                },
                "order": {
                    "trigger": [
                        "notify_sales"
                    ]
                }
            }
        }
    }
}'

Responses

🟢201Created

application/json

The workflow was created. It is always created disabled.

Bodyapplication/json

Example

{
    "data": {
        "type": "workflow",
        "id": "9f8b7c6d5e4f",
        "attributes": {
            "name": "Route hot leads to Slack",
            "description": null,
            "enabled": false,
            "workflow_type": "company",
            "version": 1,
            "definition_version": "V1",
            "definition": {
                "triggers": [
                    {
                        "name": "company_added_to_list",
                        "filters": [
                            {
                                "attribute": "list_id",
                                "op": "eq",
                                "value": "42"
                            }
                        ],
                        "options": {}
                    }
                ],
                "steps": {
                    "notify_sales": {
                        "action_name": "send_company_to_slack",
                        "options": {
                            "channel": "#sales"
                        }
                    }
                },
                "order": {
                    "trigger": [
                        "notify_sales"
                    ]
                }
            },
            "has_errors": false,
            "disabled_at": "2026-08-07T11:04:00Z",
            "disabled_reason": "manual",
            "created_at": "2026-08-07T11:04:00Z",
            "updated_at": "2026-08-07T11:04:00Z",
            "app_url": "https://app.leadfeeder.com/z/123456/workflows/9f8b7c6d5e4f"
        },
        "relationships": {
            "created_by": {
                "id": "123456",
                "type": "user"
            },
            "disabled_by": null
        }
    },
    "meta": {
        "request_id": "cf054205-dd8c-4473-8689-07c30fe0789f"
    }
}

🟠400Bad Request

🟠401Unauthorized

🟠403Forbidden

🟠429

🔴500Server Error

🔴504Gateway Timeout

Modified at 2026-08-31 12:06:53

Retrieve Workflows

Retrieve Workflow Action Definitions