Skip Navigation

ConnectApi.SurveyInvitationEmailInput

Survey invitation email.

Property	Type	Description	Required or Optional	Available Version
`allowGuestUserResponse`	Boolean	Specifies whether participants who don't have a Salesforce account can respond (`true`) or not (`false`).	Required	50.0
`allowParticipantsAccessTheirResponse`	Boolean	Specifies whether participants can see their responses (`true`) or not (`false`).	Required	50.0
`associateRecordsWithRecipients`	List<`ConnectApi.AssociateRecordsWithRecipientInput`>	Maps each recipient with another record that must be associated with the recipient's survey invitation.	Optional	50.0
`body`	String	Content of the email. Specify the email body in case you don't specify an email template. The email body must contain one of the following merge fields: To embed a link to launch the survey: [[SURVEY_INVITATION_URL]] To embed a survey question: {{{SurveyQuestion.QuestionName}}} and {{{SurveyQuestion.QuestionHtmlContent}}}	Optional	50.0
`collectAnonymousResponse`	Boolean	Specifies whether participants can respond anonymously (`true`) or not (`false`).	Required	50.0
`communityId`	String	ID of the site that's used to open the survey for users outside your org.	Optional	50.0
`emailTemplateId`	String	ID of the Lightning email template that's used to send the survey invitation. The template must contain the required merge fields that embed either the survey link or a question in the email. Only Lightning email templates are used to send survey invitations.	Optional	50.0
`fromEmailAddress`	String	Email ID of the user or the org-wide email address associated with the user's profile.	Required	50.0
`invitationExpirationDate`	Datetime	Date on which the survey invitation expires.	Optional	50.0
`invitationOwner`	String	ID of the owner of the survey invitation records.	Optional	50.0
`isPersonalInvitation`	Boolean	Specifies whether an unique invitation is created for each participant (`true`) or not (`false`). When a participant responds using a personal invitation, the response record is associated with the participant's Salesforce record.	Required	50.0
`recipientEngagementContexts`	List<`ConnectApi.RecipientEngagementContextInput`>	Maps each recipient with the context based on which the survey invitation is emailed.	Optional	50.0
`recipients`	List<String>	List of up to 300 IDs of leads, contacts, or users to whom the survey invitation is emailed.	Required	50.0
`shareInvitationsWith`	List<String>	IDs of the users with whom the survey invitation records must be shared. The invitation records are shared with Read access.	Optional	50.0
`subject`	String	Subject of the email. Specify the subject in case you don't specify an email template.	Optional	50.0
`surveyQuestionIds`	List<String>	IDs of the questions that are embedded in the email. You can send an email invitation for questions of the following types: Net Promoter Score (NPS), rating, and score.	Optional	50.0