Method: projects.locations.agents.tools.delete

Deletes a specified Tool.

HTTP request

DELETE https://{endpoint}/v3beta1/{name=projects/*/locations/*/agents/*/tools/*}

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 Tool to be deleted. Format: projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/tools/<ToolID>.

Authorization requires the following IAM permission on the specified resource name:

  • dialogflow.tools.delete

Query parameters

Parameters
force

boolean

This field has no effect for Tools not being used. For Tools that are used:

  • If force is set to false, an error will be returned with message indicating the referenced resources.
  • If force is set to true, Dialogflow will remove the tool, as well as any references to the tool.

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.