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:
value | required | description |
---|---|---|
key | yes | name of the embedded data field |
value | default value | |
type | Data field type. default is textSet. |
The types shown in the following table are valid embedded data field types:
Type passed to API | Type name in UI (as shown below) |
---|---|
text | Text |
textSet | Text Set |
number | Number |
numberSet | Number Set |
multiValueTextSet | Multi-Value Text Set |
date | Date |
filterOnly | FilterOnly |

Request Body
{"embeddedDataFields"=>[{"key"=>"<string>", "value"=>"<string>", "type"=>"<string>"}, {"key"=>"<string>", "value"=>"<string>", "type"=>"<string>"}]}
HEADERS
Key | Datatype | Required | Description |
---|---|---|---|
Content-Type | string | ||
Accept | string |
RESPONSES
status: OK
{"meta":{"httpStatus":"\u003cstring\u003e","requestId":"\u003cstring\u003e","notice":"\u003cstring\u003e"}}