Survey email.
Root XML Tag
<SurveyInvitationEmailInput>
JSON Example
{
"recipients":["003x0000003j8CEAAY"],
"collectAnonymousResponse":false,
"allowParticipantsAccessTheirResponse":false,
"allowGuestUserResponse":true,
"isPersonalInvitation":true,
"emailTemplateId":"00Xx0000000LwAuEAK",
"surveyQuestionIds":["0Kux000000003yBCAQ"],
"invitationExpirationDate":"2020-07-31T21:32:54",
"fromEmailAddress":"abeeram@salesforce.com",
"invitationOwner":"0054V00000FZTjJ",
"shareInvitationsWith":["0054V00000FZTjJ"],
"associateRecordsWithRecipients":[{"recipientId":"003x0000003j8CEAAY","associateRecordIds":["001x0000004EWIZAA4"]}],
"recipientEngagementContexts":[{"recipientId" : "003x0000003j8CEAAY","recipientEngagementContext":{"TestKey" :"TestValue"}}]
}
Properties
| Name | 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 |
Survey Recipient Survey Subjects Input[] | 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 these merge fields:<ul><li>To embed a link to launch the survey: [[SURVEY_INVITATION_URL]]</li><li>To embed a survey question: {{{SurveyQuestion.QuestionName}}} and {{{SurveyQuestion.QuestionHtmlContent}}}</li></ul> | 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 |
String | 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 a 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 |
Survey Recipient Engagement Context Input[] | Maps each recipient with the context based on which the survey invitation is emailed. | Optional | 50.0 |
recipients |
String[] | List of up to 300 IDs of leads, contacts, or users to whom the survey invitation is emailed. | Required | 50.0 |
sendEmailThroughUma |
Boolean | Specifies whether to send the email through Marketing Cloud (true) or not (false). If unspecified, defaults to false. |
Optional | 65.0 |
shareInvitationsWith |
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 |
String[] | IDs of the questions that are embedded in the email. You can send an email invitation for questions of these types: Net Promoter Score (NPS), rating, and score. | Optional | 50.0 |