Skip to content
Reference/Flows/Send Flow

Send Flow

POSThttps://public.leadpattern.com/flows/:id/send
Plan: flowsWhatsApp Connectedapplication/json60 req/min

Send a published Flow to a contact by phone (waId) or bsuid. Only flows with status "published" can be sent.

  • Header, body, footer and CTA come from the flow's sendDefaults — they cannot be overridden per request.
  • to is matched against waId or bsuid.

Headers

1 field
Authorizationstring
required
Your API key. Sent raw (e.g. 'lp_...'). No Bearer prefix required.

Path Parameters

1 field
idstring
required
Flow ID (must be published).

Body Parameters

1 field
tostring
required
Recipient waId or BSUID. The contact must already exist.

Responses

JSON Response
{
  "type": "success",
  "data": {
    "messageId": "wamid.abc123",
    "flowToken": "9c2f1e1a-2b3d-4c5e-8f6a-7b8c9d0e1f2a"
  }
}

Sample Request Body

{
  "to": "919999999999"
}