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>

NameTypeDescriptionRequired or OptionalAvailable Version
invitation​SettingsSurvey Invitation Settings InputInvitation settings of the survey.Requiredv1
languageCodeStringCode of the language to get the survey page or question details. Ensure the survey is shared to the participant in this specified language.Optionalv1
survey​Developer​NameStringName of the survey.Requiredv1
recipient​Engagement​ContextMap<String, String>Engagement context settings for a recipient of the survey.Optionalv1
related​RecordIdsString[]IDs of the records that are related to the survey.Optionalv1
static​MergeFieldsMap<String, String>Map of static merge field values.Optionalv1

Survey Description Output

<SurveyResponseInput>

Here’s an example for a single question.

NameTypeDescriptionRequired or OptionalAvailable Version
flowInterview​StateStringState of the flow interview.Requiredv1
invitationIdStringID of the survey invitation.Requiredv1
invitationUuidStringRandom ID of the survey invitation that’s generated for enhanced security.Requiredv1
languageCodeStringCode of the language to get the survey page or question details. Ensure the survey is shared to the participant in this specified language.Optionalv1
navigation​ActionStringAvailable navigation actions on the survey page. Possible values are:
  • Back—Navigate to the previous survey page.
  • Next—Navigate to the next survey page.
Requiredv1
survey​Developer​NameStringName of the survey.Requiredv1
surveyPage​ResponsesSurvey Page Response InputResponses to the survey questions on a page.Requiredv1

Survey Response Output