Skip to main content

EndSurveyOptions

EndingTypestringrequired

Whether to use the default ending options or advanced (custom)

Possible values: [Default, Advanced]

ResponseFlagstring

How to mark the response. Default QuotaMet

Possible values: [QuotaMet]

SurveyTerminationSurveyTermination (string)nullable

End of survey action such as showing respondents a response summary. See EOSMessageLibrary, EOSMessage, ResponseSummary, and EOSRedirectURL.

Possible values: [DefaultMessage, DisplayMessage, DisplayResult, ResponseSummary, Redirect]

Default value: DefaultMessage
EOSRedirectURLEOSRedirectURL (string)

The URL to redirect respondents to at the end of the survey used when SurveyTermination is set to Redirect.

EOSMessageLibraryEOSMessageLibrary (string)

End of survey message library used when SurveyTermination is set to DisplayMessage. See SurveyTermination and EOSMessage.

EOSMessageEnd of Survey Message (string)nullable

ID of the message to be displayed at the end of the survey

Possible values: Value must match regular expression ^(MS_[a-zA-Z0-9]{11,15})?$

Example: MS_abcdefg12345
EmailThankYouEmailThankYou (string)

Send an email thank you message after survey completion

Possible values: [true, false]

Default value: false
ThankYouEmailMessageLibraryThankYouEmailMessageLibrary (string)

Library ID associated with the Message ID in ThankYouEmailMessage.

Possible values: Value must match regular expression ^(UR|GR)_[a-zA-Z0-9]{11,15}$

Example: UR_SomeUserId001
ThankYouEmailMessageThankYouEmailMessage (string)nullable

ID of the library message to use for the thank you email. See EmailThankYou and ThankYouEmailMessage.

Possible values: Value must match regular expression ^(MS_[a-zA-Z0-9]{11,15})?$

Example: MS_abcdefg12345
ResponseSummaryResponseSummary (string)

Shows the response summary at the end of the survey used when SurveyTermination is set to ResponseSummary.

Possible values: [Yes, No]

Default value: No
ConfirmResponseSummarystring

Show response summary before completing the survey

Possible values: [Yes, ``]

ConfirmMessageLibraryMessageLibraryID (string)

The unique identifier for the message library.

Possible values: Value must match regular expression ^ML_[a-zA-Z0-9]{11,15}$

ConfirmMessageMessage Id (string)

The unique identifier for the message.

Possible values: Value must match regular expression ^MS_[a-zA-Z0-9]{11,15}$

CountQuotasYesNoEmptyString (string)

Yes/No/Empty String.

Possible values: [Yes, No, ``]

ScreenoutYesNoEmptyString (string)

Yes/No/Empty String.

Possible values: [Yes, No, ``]

ScreenOutNamestring
AnonymizeResponseYesNoEmptyString (string)

Yes/No/Empty String.

Possible values: [Yes, No, ``]

IgnoreResponseYesNoEmptyString (string)

Yes/No/Empty String.

Possible values: [Yes, No, ``]

EndSurveyOptions
{
  "EndingType": "Default",
  "ResponseFlag": "QuotaMet",
  "SurveyTermination": "DefaultMessage",
  "EOSRedirectURL": "string",
  "EOSMessageLibrary": "string",
  "EOSMessage": "MS_abcdefg12345",
  "EmailThankYou": "false",
  "ThankYouEmailMessageLibrary": "UR_SomeUserId001",
  "ThankYouEmailMessage": "MS_abcdefg12345",
  "ResponseSummary": "No",
  "ConfirmResponseSummary": "Yes",
  "ConfirmMessageLibrary": "string",
  "ConfirmMessage": "string",
  "CountQuotas": "Yes",
  "Screenout": "Yes",
  "ScreenOutName": "string",
  "AnonymizeResponse": "Yes",
  "IgnoreResponse": "Yes"
}