- HTTP request
- Path parameters
- Query parameters
- Request body
- Response body
- Authorization scopes
- Try it!
Deletes a specified flow.
HTTP request
DELETE https://{endpoint}/v3/{name=projects/*/locations/*/agents/*/flows/*}
Where {endpoint}
is one of the supported service endpoints
.
The URLs use gRPC Transcoding syntax.
Path parameters
Parameters
name
string
Required. The name of the flow to delete. Format: projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/flows/<FlowID>
.
Authorization requires the following IAM
permission on the specified resource name
:
-
dialogflow.flows.delete
Query parameters
Parameters
force
boolean
This field has no effect for flows with no incoming transitions. For flows with incoming transitions:
- If
forceis set to false, an error will be returned with message indicating the incoming transitions. - If
forceis set to true, Dialogflow will remove the flow, as well as any transitions to the flow (i.e. [Target flow][EventHandler.target_flow] in event handlers or [Target flow][TransitionRoute.target_flow] in transition routes that point to this flow will be cleared).
Request body
The request body must be empty.
Response body
If successful, the response body is an empty JSON object.
Authorization scopes
Requires one of the following OAuth scopes:
-
https://www.googleapis.com/auth/cloud-platform -
https://www.googleapis.com/auth/dialogflow
For more information, see the Authentication Overview .
