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.
| Name | Type | Description | Required or Optional | Available Version |
|---|---|---|---|---|
invitationSettings | Survey Invitation Settings Input | Invitation settings of the survey. The Invitation ID API doesn’t require the invitation configuration settings to be passed with the Survey Invitations. | Required | 56.0 |
languageCode | String | Code of the language in which the survey is created. | Optional | 56.0 |
recipientEngagementContext | Map<String, String> | Engagement context settings for a recipient of the survey. | Optional | 56.0 |
relatedRecordIds | String[] | IDs of the records that are related to the survey. | Optional | 56.0 |
shouldLoadPartiallyCmplSurvey | Boolean | Indicates 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. | Optional | 63.0 |
staticMergeFields | Map<String, String> | Map of static merge field values. | Optional | 56.0 |