Create Flow

Use this API to create flow.

Request Parameters

KeyDescriptionValuesData TypesRequired/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 Gupshup
namename of the flow{NAME}StringRequiredname refers to the flow name
categoriesCategory of the flow{CATEGORIES}StringRequiredcategories refers to a list of categories. Examples: SIGN_UP, SIGN_IN, APPOINTMENT_BOOKING, LEAD_GENERATION, CONTACT_US, CUSTOMER_SUPPORT, SURVEY, OTHER

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 CodeResponseComments
Success
200{ "id": "1616289422261049", "status": "success" }id refers to the flow-id generated by Meta
Error
400{ "status":"error", "message":"Blocked by Integrity" }
Language
Click Try It! to start a request and see the response here!