Create Flow

Use this API to create the flow.

Request Parameters

KeyDescriptionValueData typeRequired/OptionalConstraints
AuthorizationAccess Token for the application{{PARTNER_APP_TOKEN}}StringRequiredShould be a valid Partner App Access Token
appIdApp id of the app{{APP_ID}}StringRequiredThe ID should be a valid app ID of the Gupshup.
namename of the flow{{NAME}}StringRequiredname refers to the flow name
categoriesCategory of the flow{{CATEGORIES}}StringRequiredcategories refers to a list of categories

Sample Request

curl --location --request POST 'https://partner.gupshup.io/partner/app/{{APP_ID}}/flows/' \
--header 'Authorization: {{PARTNER_APP_TOKEN}}' \
--header 'Content-Type: application/json' \
--data-raw '{
  "name": "{{FLOW_NAME}}",
  "categories": ["{{FLOW_CATEGORY}}"]
}'

Sample Response

{
    "id": "1616289422261049",
    "status": "success"
}

Status Codes

Status Code

Response

Comments

Success

200

{

"id": "1616289422261049","status": "success"}

id refers to the flow-id generated by Meta

Error

400

{

"status": "error","message": "Flow name should be unique within one WhatsApp Business Account. Please select another name for your Flow."}

Flow name should be unique

Language
Click Try It! to start a request and see the response here!