Create flow

Creates a new WhatsApp Flow on an app from the supplied definition, so interactive screens can be attached to templates or session messages.

Request parameters

Path parameters

KeyDescriptionValuesData TypeRequired/Optional
appIdIdentifier of the WhatsApp app the call acts on.6f414190-d45c-4671-bca1-fb6c3018cb13StringRequired

Body

KeyDescriptionValuesData TypeRequired/Optional
nameFlow nameorder-tracking-flow—Required
categoriesFlow categories["OTHER"]—Required
endpoint_uriEndpoint the flow calls back into. Required for a DYNAMIC flow, omitted otherwise.https://example.com/whatsapp/flow-endpoint—Optional

Sample cURL — Create flow.

curl --request POST \
  --url 'https://partner.gupshup.io/partner/bizgate/app/6f414190-d45c-4671-bca1-fb6c3018cb13/flows' \
  --header 'Authorization: Bearer <UT>' \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --data '{
  "name" : "order-tracking-flow",
  "categories" : [ "OTHER" ]
}'

Sample success response (200)

{
  "status": "success",
  "data": {
    "id": "1616289422261049"
  }
}
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

Identifier of the WhatsApp app the call acts on.

Body Params

Flow name and categories. The flow is created in Draft status.

Create a flow, in Draft status

string
required

Flow name

categories
array of strings
required

Flow categories

categories*
string

Endpoint the flow calls back into. Required for a DYNAMIC flow, omitted otherwise.

Responses

Language
Credentials
Bearer
Universal Token (UT)
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json