Update flow

Updates the metadata of a single WhatsApp Flow — such as its name, category, or other tunable fields — without changing its screen definitions.

Request parameters

Path parameters

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

Body

KeyDescriptionValuesData TypeRequired/Optional
nameFlow name, as shown in the flow list.order-tracking-flow—Required
categoriesCategories the flow belongs to, used for reporting and discovery.["OTHER"]—Required

Sample cURL — Update flow.

curl --request PUT \
  --url 'https://partner.gupshup.io/partner/bizgate/app/6f414190-d45c-4671-bca1-fb6c3018cb13/flows/1616289422261049' \
  --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": {
    "success": true
  }
}
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.

string
required

Identifier of the WhatsApp Flow.

Body Params

Flow name and categories

string
required

Flow name, as shown in the flow list.

categories
array of strings
required

Categories the flow belongs to, used for reporting and discovery.

categories*
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