Connect REST API Request Bodies

To perform a POST, PATCH, or PUT request, pass query parameters or create a request body formatted in either XML or JSON. This chapter lists the request bodies. The query parameters are listed with each resource.

To create a JSON request body, specify the properties of the request body in JSON format.

This is an example of a Comment request body.

1{
2	"body" : "Let's look for a new solution."
3}

If a request body is top-level, it has a root XML tag listed. To create an XML request body, nest the properties as XML tags inside the root XML tag.

This is the same Connect request body in XML format:

1<comment>
2	<body>Let's look for a new solution.</body>
3</comment>

Survey Description Input

Input representation of the details of the survey recipient and their engagement context, and the language, related records, and invitation settings of the survey.
Survey Email Input

Survey email.
Survey Integer Question Response Input

Input representation of the details of the response to an NPS question on the survey page.
Survey Invitation Settings Input

Input representation of the settings of the survey invitation that define the participants who can respond to the survey, its expiration, and other related configurations.
Survey Page Response Input

Input representation of the details of the response to a survey page.
Survey Question Response Input

Input representation of the details of the response to a question on the survey page.
Survey Recipient Engagement Context Input

Context based on which the survey invitation is sent to a participant.
Survey Recipient Survey Subjects Input

Records associated with the survey invitation.
Survey Response Input

Input representation of the details of a survey response.
Survey Selection Question Choice Input

The details of a boolean, rating, single selection, or a multiple selection question’s choice on the survey page.
Survey Selection Question Response Input

Input representation of the details of the response to a boolean, rating, single selection, or a multiple selection question on the survey page.
Survey Text Question Response Input

The details of the response to a short-text or a long-text question on the survey page.