POST
/
api
/
v1
/
followups

Authorizations

​
X-Aftercare-Key
string
header
required

API key for authentication

Body

application/json
​
answer
string
required

The answer to the question

​
question
string
required

The top-level topic question that was asked

​
surveyName
string
required

Name of the survey

​
guidanceBehavior
enum<string>
default:
Succint

Different ways Aftercare AI will generate follow-up questions based on non-applicable user input.

  • Succinct - The AI will not generate a follow-up question if the response is irrelevant or complete. This is the default behavior.
  • Redirection - The AI will return a follow-up question that redirects the user to answering the top-level question if it is irrelevant and incomplete.
  • Verbose - The AI will return a follow-up question regardless of the relevance or completeness of the response. This is the most verbose behavior.
Available options:
Succinct,
Redirection,
Verbose
​
questionContext
string

What is trying to be achieved with this question

​
surveyDescription
string

Description of the survey purpose

​
surveyIdentifier
string

A unique identifier for the survey. Aftercare will use this to generate useful metrics

Response

200 - application/json
​
followupQuestion
string
required

The generated followup question

​
responseEvaluation
object
required
Introduction