Surveys

Create a survey

Author a new conversational survey from a question set.

post/surveys

Request

  • Base URL: https://rcs-templates-api-dot-msg2ai-server.ue.r.appspot.com/api/agent
  • URL: https://rcs-templates-api-dot-msg2ai-server.ue.r.appspot.com/api/agent/surveys
  • Auth: HTTP bearer

Request body

namestring required
descriptionstring
definitionobject required

SurveyDefinition: { intro?, outro?, questions: [{ questionId, prompt, type, options?, minRating?, maxRating?, required? }] }.

startDatestring

ISO date; schedules the survey.

endDatestring
timezonestring
languageCodestring[]
isPreferencesSurveyboolean
channel'RCS' | 'WHATSAPP'

Channel to act on (RCS or WHATSAPP). Defaults to your org's own brand channel; any other channel requires the matching add-on brand.

Response

Success.

object required

Changes

No recorded changes to this operation across all 1 revision of this API.