post https://partner.gupshup.io/partner/app//flows
Use this API to create flow.
Request Parameters
Key | Description | Values | Data Types | Required/Optional | Constraints |
---|---|---|---|---|---|
Authorization | Access Token for the application | {PARTNER_APP_TOKEN} | String | Required | Should be a valid Partner App Access Token |
appId | App id of the app | {APP_ID} | String | Required | The Id should be a valid app Id of Gupshup |
name | name of the flow | {NAME} | String | Required | name refers to the flow name |
categories | Category of the flow | {CATEGORIES} | String | Required | categories 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 Code | Response | Comments |
---|---|---|
Success | ||
200 | { "id": "1616289422261049", "status": "success" } | id refers to the flow-id generated by Meta |
Error | ||
400 | { "status":"error", "message":"Blocked by Integrity" } |