New Articles

  1. sgapiHideOption(%%questionID,%%reportingvalue, true/false)

    This function hides an answer option by reporting value. The true/false parameter can be used to support changes in answer options when respondents use the back button. For grid questions the answer fields in column associated with that repo...
  2. sgapiRemoveOption(%%questionID,%%reportingvalue)

    This function removes an multiple choice option (by reporting value as %%reportingvalue). For table questions it hides the column associated with that reporting value for all rows. This will not reset if back button is used. If you'd like to have th...
  3. sgapiHidePage(%%pageID,true/false)

    This function hides or shows a page. Example In this example script we hide pages 3 and 4 by default by setting sgapiHidePage for these page IDs to true. Then, based on the answer to the jedi or sith question on page one we set the sgap...
  4. sgapiHideQuestion(%%questionID,true/false)

    This function hides when set to true and shows a question when set to false. Example In the below script we hide question ID 3 by default. Then if question 1 is "yes" it is shown by setting sgapiHideQuestion to false. sgapiHideQu...
  5. sgapiGetQuestionOptions(%%questionID, %%type)

    This function returns an array of options for the given question. %%type can be "Reporting" or "Title" (default for type is "Title"). Example The below script outputs both the answer option titles and reporting values to the page. ...
  6. sgapiSetTEXTEmail(%%questionID,%%value,%%language)

    This function sets the content of the TEXT version of a send email action. Parameters %%questionID - The ID of the send email action for which you are specifying content. %%value - The content you wish to use (string). %...
  7. sgapiSetHTMLEmail(%%questionID,%%value,%%language = "English")

    This function sets the content of an HTML version of a send email action. Parameters %%questionID - The ID of the send email action for which you are specifying content. %%value - The content you wish to use (string). ...
  8. sgapiRemoveContactFromInvite(%%linkID, %%email)

    This function removes the given contact from the given invite as specified by %%linkID. linkID is the inviteID and can be found in your email campaign. Example In this example, we'll remove a contact from the email campaign with ID 1234...
  9. sgapiAddContactToInvite(%%linkID, %%email, %%fields, %%customfields, %dupsok)

    This function adds a contact with the list of given fields to the given invite. %%linkID* is the Invite ID of your email campaign %%email * is the email address of the contact you'd like to add %%fields is an array of the conta...
  10. sgapiGetTitle(%%questionID,%%language)

    This function returns the title of a question. Using the %%language parameter you can return the title in the given language. The values are the languages available in the translation menu. %%language must be title case. Example ...