Skip to main content

Create Response with File Attachments Request

response objectrequired
values objectrequired

values is a set of key-value pairs corresponding to question-answer pairs. There can also be key-value pairs representing meta data for the response such as startDate or userLanguage.

distributionChanneldistributionChannel (string)

The method by which the survey was distributed to respondents

durationduration (integer)

How long it took for the respondent to finish the survey in seconds

endDatestring<date-time>

The point in time when the survey response was finished

finishedfinished (integer)

If the respondent finished and submitted the survey, the value will be 1, otherwise it will be 0

locationLatitudelocationLatitude (string)

The approximate location of the respondent at the time the survey was taken

locationLongitudelocationLongitude (string)

The approximate location of the respondent at the time the survey was taken

progressprogress (integer)

How far the respondent has progressed through the survey as a percentage

startDatestring<date-time>

The point in time when the survey response was started

userLanguageuserLanguage (string)

The language of the respondent

property name*any

values is a set of key-value pairs corresponding to question-answer pairs. There can also be key-value pairs representing meta data for the response such as startDate or userLanguage.

property name*any
fileMapping objectrequired
file1file1 (string)

The QuestionID of the file upload question to map file1 to

Example: QID1
file2file2 (string)

The QuestionID of the file upload question to map file2 to

Example: QID2
file3file3 (string)

The QuestionID of the file upload question to map file3 to

Example: QID3
file4file4 (string)

The QuestionID of the file upload question to map file4 to

Example: QID4
file5file5 (string)

The QuestionID of the file upload question to map file5 to

Example: QID5
file1string<binary>

Possible values: <= 5242880 characters

file2string<binary>

Possible values: <= 5242880 characters

file3string<binary>

Possible values: <= 5242880 characters

file4string<binary>

Possible values: <= 5242880 characters

file5string<binary>

Possible values: <= 5242880 characters

Create Response with File Attachments Request
{
"response": {
"values": {
"distributionChannel": "string",
"duration": 0,
"endDate": "2024-07-29T15:51:28.071Z",
"finished": 0,
"locationLatitude": "string",
"locationLongitude": "string",
"progress": 0,
"startDate": "2024-07-29T15:51:28.071Z",
"userLanguage": "string"
}
},
"fileMapping": {
"file1": "QID1",
"file2": "QID2",
"file3": "QID3",
"file4": "QID4",
"file5": "QID5"
},
"file1": "string",
"file2": "string",
"file3": "string",
"file4": "string",
"file5": "string"
}