Skip to main content
POST
/
whatsapp
/
flows
Create flow
curl --request POST \
  --url https://api.kapso.ai/platform/v1/whatsapp/flows \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "phone_number_id": "<string>",
  "name": "<string>",
  "flow_json": {},
  "publish": false
}
'
{
  "data": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "meta_flow_id": "<string>",
    "name": "<string>",
    "status": "draft",
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z",
    "json_version": "<string>",
    "data_api_version": "<string>",
    "business_account_id": "<string>",
    "preview_url": "<string>",
    "published_at": "2023-11-07T05:31:56Z",
    "last_synced_at": "2023-11-07T05:31:56Z",
    "data_endpoint_function_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "phone_number_id": "<string>",
    "data_endpoint_url": "<string>",
    "has_data_endpoint": true,
    "flows_encryption_configured": true
  }
}

Authorizations

X-API-Key
string
header
required

Body

application/json
phone_number_id
string
required

Meta phone number ID to use

name
string

Flow name (auto-generated if omitted)

flow_json
object

WhatsApp Flow JSON (defaults to a basic welcome screen)

publish
boolean
default:false

Publish immediately after creation

Response

Flow created

data
object
required