Insert Embedded Data Fields

POST {{baseUrl}}/surveys/:surveyId/embeddeddatafields

Insert embedded data fields into a survey. <!--From Readme-->

Embedded Field Requirements

Embedded data means user-defined data, as in free-form data.

Embedded Data fields used in a survey can be pulled from data that you have uploaded into a contact list, appended to the respondent’s survey link, or set in the Survey Flow.

Embedded data field requirements:

valuerequireddescription
keyyesname of the embedded data field
valuedefault value
typeData field type. default is textSet.

The types shown in the following table are valid embedded data field types:

Type passed to APIType name in UI (as shown below)
textText
textSetText Set
numberNumber
numberSetNumber Set
multiValueTextSetMulti-Value Text Set
dateDate
filterOnlyFilterOnly
Embedded data options

Request Body

{"embeddedDataFields"=>[{"key"=>"<string>", "value"=>"<string>", "type"=>"<string>"}, {"key"=>"<string>", "value"=>"<string>", "type"=>"<string>"}]}

HEADERS

KeyDatatypeRequiredDescription
Content-Typestring
Acceptstring

RESPONSES

status: OK

{&quot;meta&quot;:{&quot;httpStatus&quot;:&quot;\u003cstring\u003e&quot;,&quot;requestId&quot;:&quot;\u003cstring\u003e&quot;,&quot;notice&quot;:&quot;\u003cstring\u003e&quot;}}