Method: conversations.surveys.create

  • Sends customer satisfaction surveys within conversations using an HTTP POST request to the specified URL.

  • Only the first survey initiated within a 24-hour period in a conversation will be sent to the user.

  • Each survey requires a unique surveyId assigned by the agent to be processed, reusing IDs will result in the request being ignored.

  • Requires authorization with the https://www.googleapis.com/auth/businessmessages scope.

Creates a customer satisfaction survey in a conversation.

If an agent sends multiple surveys in the same conversation within 24 hours, Business Messages only attempts to send the first survey to the user.

HTTP request

POST https://businessmessages.googleapis.com/v1/{parent=conversations/*}/surveys

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
parent

string

Required. The conversation that contains the survey. Resolves to "conversations/{conversationId}".

Query parameters

Parameters
surveyId

string

The unique identifier of the survey, assigned by the agent. If a survey attempts to use the same surveyId as a previous survey, Business Messages ignores the request.

Request body

The request body contains an instance of Survey.

Response body

If successful, the response body contains a newly created instance of Survey.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/businessmessages

For more information, see the OAuth 2.0 Overview.