sgapiDisqualify(%%message)

Important Update to Custom Scripting

The CustomScript Action now supports the LUA programming language. Visit our NEW Lua Scripting Resources!


  1. New accounts (created after October 29, 2018) will only have the option to use Lua in scripts.
  2. As of October 29, 2018 Custom Scripting Actions will default to Lua as the scripting type in the Custom Scripting Action for accounts created before this date. You will be able to switch to the Legacy Custom Scripting; though we highly encourage using Lua.
  3. In the long term, Legacy Custom Scripting Actions will be switched to read-only. The exact date on this is to be determined; we will send notifications well ahead of time.

This function disqualifies the user and ends the survey. %%message will display your customized message to the respondent.

Example

In this example, if the answer to question ID 2 is "no" and there are fewer than 3 answered questions on page ID 1, then the respondent is disqualified.

Check it out in an Example Survey

%%question1 = sgapiGetValue(2);
%%numberAnswered = sgapiQuestionsAnsweredOnPage(1);

if (%%question1 == "no" && %%numberAnswered < 3)
{
    sgapiDisqualify("You have been disqualified");
}