Method: projects.locations.conversations.patch

Updates a conversation.

HTTP request

PATCH https://{endpoint}/v1/{conversation.name=projects/*/locations/*/conversations/*}

Where {endpoint} is one of the supported service endpoints.

The URLs use gRPC Transcoding syntax.

Path parameters

Parameters
conversation.name

string

Immutable. The resource name of the conversation. Format: projects/{project}/locations/{location}/conversations/{conversation}

Query parameters

Parameters
updateMask

string (FieldMask format)

The list of fields to be updated. All possible fields can be updated by passing *, or a subset of the following updateable fields can be provided:

  • agentId
  • languageCode
  • labels
  • metadata
  • qualityMetadata
  • callMetadata
  • startTime
  • expireTime or ttl
  • dataSource.gcs_source.audio_uri or dataSource.dialogflow_source.audio_uri

This is a comma-separated list of fully qualified names of fields. Example: "user.displayName,photo".
allowMissing

boolean

Optional. Defaults to false. If set to true, and the conversation is not found, a new conversation will be created. In this situation, updateMask is ignored.

Request body

The request body contains an instance of Conversation.

Response body

If successful, the response body contains an instance of Conversation.

Authorization scopes

Requires the following OAuth scope:

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

For more information, see the Authentication Overview.

IAM Permissions

Requires one of the following IAM permissions on the name resource, depending on the resource type:

  • contactcenterinsights.authorizedConversations.update
  • contactcenterinsights.conversations.update
  • contactcenterinsights.datasetConversations.update

For more information, see the IAM documentation.