Survey Responses Using Invitation Configurations (POST, PATCH)
Create responses using the invitation configuration details and initiate the process of submitting the survey responses by making a POST request. Submit the survey responses using the PATCH request.
Salesforce Feedback Management Business API performance can be impacted if a POST request exceeds 3600 calls per minute and if a PATCH request exceeds 1800 calls per minute at the organization level.
You can create a survey to collect data from customers, employees, or other people whose feedback you need. The survey responses are stored in the SurveyResponse object and the responses to individual questions in the SurveyQuestionResponse object.
v1
No
PATCH, POST
The HTTP header request format only accepts Content-Type: application/json.
The Feedback Management - Growth license is required to use this resource.
Ensure the survey is shared to the guest profile from Sharing Settings in Salesforce Setup.
Use the bearer token from the accessToken request.
To use the participant or associated record merge fields, ensure these prerequisites are met.
- Access level for merge fields is set to System Context - Enforce record-level access. See Select the Access Level for Merge Fields.
- Share the records used in merge fields to the guest profile from Sharing Settings in Salesforce Setup.
See Also
<SurveyDescriptionInput>
| Name | Type | Description | Required or Optional | Available Version |
|---|---|---|---|---|
invitationSettings | Survey Invitation Settings Input | Invitation settings of the survey. | Required | v1 |
languageCode | String | Code of the language to get the survey page or question details. Ensure the survey is shared to the participant in this specified language. | Optional | v1 |
surveyDeveloperName | String | Name of the survey. | Required | v1 |
recipientEngagementContext | Map<String, String> | Engagement context settings for a recipient of the survey. | Optional | v1 |
relatedRecordIds | String[] | IDs of the records that are related to the survey. | Optional | v1 |
staticMergeFields | Map<String, String> | Map of static merge field values. | Optional | v1 |
<SurveyResponseInput>
Here’s an example for a single question.
| Name | Type | Description | Required or Optional | Available Version |
|---|---|---|---|---|
flowInterviewState | String | State of the flow interview. | Required | v1 |
invitationId | String | ID of the survey invitation. | Required | v1 |
invitationUuid | String | Random ID of the survey invitation that’s generated for enhanced security. | Required | v1 |
languageCode | String | Code of the language to get the survey page or question details. Ensure the survey is shared to the participant in this specified language. | Optional | v1 |
navigationAction | String | Available navigation actions on the survey page. Possible values are:
| Required | v1 |
surveyDeveloperName | String | Name of the survey. | Required | v1 |
surveyPageResponses | Survey Page Response Input | Responses to the survey questions on a page. | Required | v1 |