Publish, deprecate and delete Flows
Last update: 6 hours ago by Irais Aguirre
Publish, deprecate and delete WhatsApp Flows.
Integration summary
- Base URL:
https://{{url}}/whatsapp-bsp-admin-ext-endpoint-ws/services- Token: admin token, in the
Authorization: Bearer {{admin-token}}header (how to generate it)- Endpoints on this page:
POST /v1/flows/{{waba_id}}/{{flow_id}}/publish: Publish a FlowPOST /v1/flows/{{waba_id}}/{{flow_id}}/deprecate: Deprecate a FlowDELETE /v1/flows/{{waba_id}}/{{flow_id}}: Delete a Flow
Publish a Flow
Request
Publish a Flow request:
| URL | https://{{url}}/whatsapp-bsp-admin-ext-endpoint-ws/services/v1/flows/{{waba_id}}/{{flow_id}}/publish |
| Method | POST |
Headers
Publish a Flow headers:
| Name | Description | Type | Requirements |
|---|---|---|---|
| Authorization | Admin token. See Generate authentication token. | String | Required |
Parameters
Publish a Flow parameters:
| Name | Description | Type | Requirements |
|---|---|---|---|
| waba_id | WhatsApp Business Account ID. | String | Required |
| flow_id | Flow ID returned by Create Flow. | String | Required |
Example
Complete Publish a Flow example:
curl --location --request POST 'https://{{url}}/whatsapp-bsp-admin-ext-endpoint-ws/services/v1/flows/{{waba_id}}/{{flow_id}}/publish' \--header 'Authorization: Bearer {{admin-token}}'
Response
Publish a Flow response:
| Name | Description | Type |
|---|---|---|
| success | Returns true if the Flow was published successfully; otherwise, returns false. | Boolean |
{"success": true}
Deprecate a Flow
Request
Deprecate a Flow request:
| URL | https://{{url}}/whatsapp-bsp-admin-ext-endpoint-ws/services/v1/flows/{{waba_id}}/{{flow_id}}/deprecate |
| Method | POST |
Headers
Deprecate a Flow headers:
| Name | Description | Type | Requirements |
|---|---|---|---|
| Authorization | Admin token. See Generate authentication token. | String | Required |
Parameters
Deprecate a Flow parameters:
| Name | Description | Type | Requirements |
|---|---|---|---|
| waba_id | WhatsApp Business Account ID. | String | Required |
| flow_id | Flow ID returned by Create Flow. | String | Required |
Example
Complete Deprecate a Flow example:
curl --location --request POST 'https://{{url}}/whatsapp-bsp-admin-ext-endpoint-ws/services/v1/flows/{{waba_id}}/{{flow_id}}/deprecate' \--header 'Authorization: Bearer {{admin-token}}'
Response
Deprecate a Flow response:
| Name | Description | Type |
|---|---|---|
| success | Returns true if the Flow was deprecated successfully; otherwise, returns false. | Boolean |
{"success": true}
Delete a Flow
Request
Delete a Flow request:
| URL | https://{{url}}/whatsapp-bsp-admin-ext-endpoint-ws/services/v1/flows/{{waba_id}}/{{flow_id}} |
| Method | DELETE |
Headers
Delete a Flow headers:
| Name | Description | Type | Requirements |
|---|---|---|---|
| Authorization | Admin token. See Generate authentication token. | String | Required |
Parameters
Delete a Flow parameters:
| Name | Description | Type | Requirements |
|---|---|---|---|
| waba_id | WhatsApp Business Account ID. | String | Required |
| flow_id | Flow ID returned by Create Flow. | String | Required |
Example
Complete Delete a Flow example:
curl --location --request DELETE 'https://{{url}}/whatsapp-bsp-admin-ext-endpoint-ws/services/v1/flows/{{waba_id}}/{{flow_id}}' \--header 'Authorization: Bearer {{admin-token}}'
Response
Delete a Flow response:
| Name | Description | Type |
|---|---|---|
| success | Returns true if the Flow was deleted successfully; otherwise, returns false. | Boolean |
{"success": true}