Skip to main content
POST
Create flow (phone number scoped)

Authorizations

X-API-Key
string
header
required

Project API key for authentication. This is the recommended authentication method.

Get your API key from the Kapso dashboard under Integrations > API keys.

Path Parameters

phone_number_id
string
required

WhatsApp Business Phone Number ID

Body

application/json
name
string
required

Flow name

categories
enum<string>[]
required

Flow categories

Available options:
SIGN_UP,
SIGN_IN,
APPOINTMENT_BOOKING,
LEAD_GENERATION,
CONTACT_US,
CUSTOMER_SUPPORT,
SURVEY,
OTHER
clone_flow_id
string

ID of flow to clone

endpoint_uri
string<uri>

Endpoint URI for the flow

flow_json
string

Flow's JSON encoded as string. If provided with publish=true, creates and publishes flow in one request.

publish
boolean

Indicates whether Flow should also get published. Only works if flow_json is provided with valid Flow JSON.

Response

Flow created successfully

id
string

Flow ID

success
boolean
validation_errors
object[]