API ReferenceWorkflows

Update workflow

Update a workflow the team owns. If name or system_prompt is sent, they must be non-blank.

PATCH
/api/v1/console/workflows/{workflowId}

Authorization

ApiKeyAuth
AuthorizationBearer <token>

Team API key (prefix sk_). You may also send the key via X-Api-Key header.

In: header

Path Parameters

workflowId*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

curl -X PATCH "https://example.com/api/v1/console/workflows/string" \  -H "Content-Type: application/json" \  -d '{}'
{  "message": "Success",  "data": {    "system_prompt": "string",    "rules": [      {        "id": "string",        "name": "string",        "trigger": "string",        "condition": "string",        "response": "string",        "action": "string",        "enabled": true      }    ],    "flows": [      {        "name": "string",        "description": "string",        "category": "support",        "priority": 5,        "is_active": true,        "trigger_keywords": [          {            "keyword": "string",            "weight": "high"          }        ],        "conversation_steps": [          {            "type": "text_response",            "content": "string",            "action": "string",            "followup": "string"          }        ]      }    ],    "tags": [      "string"    ],    "integrations": [      "string"    ],    "channels": [      "string"    ],    "actions": [      "string"    ],    "guide": {      "youtubeUrl": "string",      "steps": [        "Step 1: Configure your store",        "Step 2: Add products"      ]    },    "faq": [      {        "question": "string",        "answer": "string"      }    ],    "setup_steps": [      "string"    ],    "setup_time": 0,    "video_url": "string",    "id": "string",    "name": "string",    "description": "string",    "category": "string",    "visibility": "private",    "is_owner": true,    "created_at": "2019-08-24T14:15:22Z",    "updated_at": "2019-08-24T14:15:22Z"  }}
{  "message": "string",  "error": "string",  "code": "string",  "statusCode": 0,  "request_id": "266ea41d-adf5-480b-af50-15b940c2b846"}

List workflows

List workflows. scope=accessible (default) returns team-owned plus public/recommended; scope=owned or scope=public filter further.

Create conversation and send message

Send to an existing conversation (conversation_id) or create/find by channel_type + channel_user_id. Supports whatsapp, webchat, telephony (test and live where configured).