Skip to main content

GuidedSellingQuestion

BETA: guided selling can still change in ways that break existing integrations. Backwards compatibility is not guaranteed while it is in beta.

The next question to show, with its options.

type GuidedSellingQuestion {
version: Int!
questionId: ID!
question: String!
acknowledgement: String
options: [GuidedSellingOption!]!
freeTextAllowed: Boolean!
}

Fields​

GuidedSellingQuestion.version ● Int! non-null scalar​

Flow version this step was produced on. There is nothing to send back: question ids carry it.

GuidedSellingQuestion.questionId ● ID! non-null scalar​

Identifier of this question. Send it back in answers, with the option the customer picked or the text they typed. It carries the flow version, which is what keeps a conversation on its version.

GuidedSellingQuestion.question ● String! non-null scalar​

In the language of the request.

GuidedSellingQuestion.acknowledgement ● String scalar​

One short line acknowledging what the customer just said. Absent on the opener.

GuidedSellingQuestion.options ● [GuidedSellingOption!]! non-null object​

The answers the customer can choose from, two to six.

GuidedSellingQuestion.freeTextAllowed ● Boolean! non-null scalar​

Whether the customer may type an answer instead of choosing an option: always the flow's freeText setting.

Member Of​

GuidedSellingConversationTurn object

Implemented By​

GuidedSellingStepResult union