Dynamic Send Survey Invitation Actions

Send customized notifications to users about important events or updates to the records that they’re working on. For example, notify account owners when a case is created.

This action is available in API version 51.0 and later.

Special Access Rules

To access the Dynamic Send Survey Invitation action, you must have the Feedback Management Survey Response Pack and the Salesforce org enabled with Surveys.

Supported REST HTTP Methods

URIs:

Get the list of invocable actions for each available survey:

/services/data/vXX.X/actions/custom/dynamicSendSurveyInvitation

Where XX.X is the lastes API version.
Send survey invitation by email by using the invocable action:

/services/data/v51.0/actions/custom/dynamicSendSurveyInvitation/SURVEY_NAME

Where SURVEY_NAME is a variable.

Formats: JSON, XML

HTTP Methods: GET, HEAD, POST

Authentication: Authorization: Bearer TOKEN

Where TOKEN is a variable.

Inputs

Input	Type	Description
`anonymousResponse`	boolean	Indicates whether the participant’s name is recorded in the response record (`true`) or not (`false`).
`autoExpiryDays`	integer	Number of days remaining for the survey invitation to expire.
`emailTemplateName`	string	Developer name of the template that contains either the question or the survey link.
`isUnauthenticatedResponse`	boolean	Indicates whether the participant is required to authenticate before starting the survey (`true`) or not (`false`).
`personalInvitation`	boolean	Indicates whether the invitation is specific to the recipient (`true`) or not (`false`).
`recipient`	reference	Required. Salesforce ID of the record that the survey invitation is sent to.
`recipientType`	string	Type of the survey recipient.
`surveyQuestionName`	string	Developer name of the question that’s sent by using the invitation.
`surveySubjectEntity`	reference	ID of the record that associates the invitation record with another record.

Outputs

None.

Example

GET

This example shows how to get information about the Dynamic Send Survey Invitation action type.

1curl --include --request GET \
2--header "Authorization: Authorization: Bearer 00DR...xyz" \
3--header "Content-Type: application/json" \
4"https://instance.salesforce.com/services/data/v51.0/actions/custom/dynamicSendSurveyInvitation"

Here’s a response that returns the list of invocable actions for each survey.

1{
2  "actions" : [ {
3    "label" : "flowsend",
4    "name" : "flowsend",
5    "type" : "SEND_SURVEY_DYNAMIC_INVOCABLE_ACTION",
6    "url" : "/services/data/v51.0/actions/custom/dynamicSendSurveyInvitation/flowsend"
7  }, {
8    "label" : "survey2",
9    "name" : "survey2",
10    "type" : "SEND_SURVEY_DYNAMIC_INVOCABLE_ACTION",
11    "url" : "/services/data/v51.0/actions/custom/dynamicSendSurveyInvitation/survey2"
12  }, {
13    "label" : "survey",
14    "name" : "survey",
15    "type" : "SEND_SURVEY_DYNAMIC_INVOCABLE_ACTION",
16    "url" : "/services/data/v51.0/actions/custom/dynamicSendSurveyInvitation/survey"
17  } ]
18}

POST

Here’s a request for the Dynamic Send Survey Invitation action.

1{
2   "inputs":[{
3      "recipient" : "003xx000004WpemAAC",
4      "isUnauthenticatedResponse" : false,
5      "autoExpiryDays" : 6
6   }]
7}

Here’s a response for the Dynamic Send Survey Invitation action.

1[
2   {
3      "actionName" : "survey",
4      "errors" : null,
5      "isSuccess" : true,
6      "outputValues" : null
7   }
8]