Typebot
Start flow
Manually starts a Typebot flow for a number, triggering the startChat
POST
Start flow
Auth:
TokenAccount or TokenInstance • Rate limit: Global (100/min) • Idempotent: no
Description
Manually starts a Typebot flow for a number, without waiting for a trigger message. RyzeAPI fires thestartChat of the indicated bot and persists the session. Useful for outbound campaigns and to resume a conversation from your backend.
The instance must already have at least one registered bot (an active integration).
Example
Success response
200 OK
Path parameters
string
required
Instance name (e.g.,
suporte).Headers
string
required
TokenAccount or TokenInstance.string
required
application/jsonRequest body
string
required
Destination number in E.164 format without the
+ (e.g., 5511999999999).string
required
UUID of the bot to start, obtained from
GET /api/typebot/list/:instance.object
Prefilled variables passed to Typebot (
string → string map). Ex.: { "nome": "João", "plano": "premium" }.Errors
Next
List bots
Find the
botId to use with GET /api/typebot/list/:instance.Register bot
Configure a bot before starting flows manually.