Create WhatsApp Flow

Create a WhatsApp flow. If successful, flow will be created in DRAFT status with default flow.json. Flow.json contains structure of the flow and other fields given in request can be updated until publication.

post/whatsapp/1/senders/{sender}/flows

Request

Base URL
https://api.infobip.com (the document declares no server; this is the origin it was published from)
Auth
- OAuth 2
  Client credentials
  Token URL: https://api.infobip.com/auth/1/oauth2/token
- or API key in header Authorization
- or API key in header Authorization
- or HTTP basic

Path parameters

senderstring required

Registered WhatsApp sender number. Must be in international format.

Request body

namestring required

Name of the flow.

categories0089ea7cf06f0b77e4c88a7276c6f25dd5c0c5bbab819756fc42c548980cae19FlowCategory[] required

Categories of the flow.

cloneFlowIdstring

ID of source Flow to clone. The new flow with DRAFT status will inherit the flow.json from source flow.

Example request

{
  "name": "My first flow",
  "categories": [
    "SIGN_UP"
  ],
  "cloneFlowId": "987654"
}

Response

Flow Created

idstring required

ID of the flow.

namestring required

Name of the flow.

businessAccountIdinteger required

WhatsApp business account ID.

categories0089ea7cf06f0b77e4c88a7276c6f25dd5c0c5bbab819756fc42c548980cae19FlowCategory[] required

Categories of the flow.

status'DRAFT' | 'PUBLISHED' | 'DEPRECATED' | 'BLOCKED' | 'THROTTLED' required

Status of the flow.

initialScreensstring[]

IDs of the initial screens required to send a flow with flowAction set to 'NAVIGATE'. Only exists for flows after publishing.

Example response

{
  "id": "123456",
  "name": "My first flow",
  "businessAccountId": 987654,
  "categories": [
    "SIGN_UP"
  ],
  "status": "DRAFT"
}

Changes

No recorded changes to this operation across all 1 revision of this API.