Updates: Check the release notes for new features and product updates.

Method: conversations.surveys.create

Creates a customer satisfaction survey in a conversation.

If an agent sends multiple surveys in the same conversation within 24 hours, surveys after the first return a RESOURCE_EXHAUSTED error.

If the client doesn't support the survey feature, survey returns a FAILED_PRECONDITION error.

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 returns an ALREADY_EXISTS error.

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.