Skip to main content
PATCH

Authorizations

​
X-API-Key
string
header
required

Path Parameters

​
flowId
string
required

Flow ID.

Example:

"flow-1"

Body

application/json
​
name
string

Flow name.

Example:

"New flow name"

​
categories
enum<string>[]

Flow categories.

Category of the WhatsApp Flow.

  • SIGN_UP: For sign-up processes.
  • SIGN_IN: For sign-in processes.
  • APPOINTMENT_BOOKING: For booking appointments.
  • LEAD_GENERATION: For lead generation.
  • CONTACT_US: For contact forms.
  • CUSTOMER_SUPPORT: For customer support.
  • SURVEY: For surveys.
  • OTHER: For other purposes.
Available options:
SIGN_UP,
SIGN_IN,
APPOINTMENT_BOOKING,
LEAD_GENERATION,
CONTACT_US,
CUSTOMER_SUPPORT,
SURVEY,
OTHER
​
endpointUri
string

The endpoint URI for the Flow.

Example:

"https://example.com/flow-endpoint"

Response

200 - application/json

Successfully updated the flow metadata.

​
success
boolean

Whether the operation was successful.

Example:

true