sgapiSubmitSurveyComplete()

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 submits the data on the current page and records the response as complete. All data collected on previous pages will be stored for reporting.

Note: this will not submit the current page and move to the next. To do that, use sgapiJumpToPage.

Examples

This one is super easy, just include this one line to mark the survey as complete when the action is run. Custom Script actions are run when the page is displayed.

sgapiSubmitSurveyComplete();

You could also use this to mark a survey as complete under certain conditions:

%%gender = sgapiGetValue(2);
if (%%gender = "male") sgapiSubmitSurveyComplete();