Survey Description Input

Input representation of the details of the survey recipient and their engagement context, and the language, related records, and invitation settings of the survey.

Properties 

NameTypeDescriptionRequired or OptionalAvailable Version
invitationSettingsSurvey Invitation Settings InputInvitation settings of the survey. The Invitation ID API doesn’t require the invitation configuration settings to be passed with the Survey Invitations.Required56.0
languageCodeStringCode of the language in which the survey is created.Optional56.0
recipient​Engagement​ContextMap<String, String>Engagement context settings for a recipient of the survey.Optional56.0
relatedRecordIdsString[]IDs of the records that are related to the survey.Optional56.0
shouldLoad​PartiallyCmpl​SurveyBooleanIndicates whether to load partially completed surveys when a partially completed survey is selected (true), or to start a new survey (false). The default value is false.Optional63.0
staticMergeFieldsMap<String, String>Map of static merge field values.Optional56.0