Qodex.ai

Import Recipients with Data in Excel

POST https://rest.webropolsurveys.com/api/v1/surveys/{{SurveyId}}/importRecipientWithDemData

Import Recipients with demographic data from a Excel file.

NOTE

  • You will need to download the Excel template from the survey in UI (Collect Responses -> Add Recipients)
  • Make sure to download the full Excel template, even if you won't fill in all the questions
  • Do not change the two header rows or upload will fail!
  • Use allowDuplicates: true as a key-value pair in body to allow duplicate emails
  • Use IsSubmit: true as a key-value pair body to submit respondents and responses to report. Responding not available to uploaded respondents.
  • Selection question data can be in text format. System converts data to numeric and corresponding value.

Request Body

[{"name"=>"File", "value"=>nil, "datatype"=>"null"}, {"name"=>"allowDuplicates", "value"=>"true", "datatype"=>"boolean"}, {"name"=>"isSubmited", "value"=>"true", "datatype"=>"boolean"}]

HEADERS

KeyDatatypeRequiredDescription
Content-Typestring

RESPONSES

status: OK

{"RecipientsAdded":["66408d69-2dbe-423b-bf4a-9e20a859f3c6"],"ScheduledFileId":"6b467c19-15b8-4d4c-a202-b02000a1a225","Message":"2 out of 2 recipients uploaded successfully","IsFailed":false,"IsScheduled":false,"HasDetailedErrors":false,"DetailedErrors":null}