Method: conversations.delete

Full name: projects.locations.instances.users.conversations.delete

DeleteConversation is used to delete a conversation. Deleting a conversation also deletes all the corresponding messages.

HTTP request

DELETE https://chronicle.googleapis.com/v1alpha/{name}

Path parameters

Parameters
name

string

Required. The name of the conversation to delete. Format: projects/{project}/locations/{location}/instances/{instance}/users/{user}/conversations/{conversation}

Query parameters

Parameters
force

boolean

Optional. If set to true, any messages from this conversation will also be deleted. Otherwise, the request will only work if the conversation has no messages.

Request body

The request body must be empty.

Response body

If successful, the response body is empty.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the name resource:

  • chronicle.conversations.delete

For more information, see the IAM documentation.