Qodex.ai

Import Recipients with Data in JSON

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

Import Recipients with demographic data as a JSON.

Surveys id {{surveyId}} is guid that you can find out by listing surveys with GET /surveys. Example of guid eabb5f9a-1af5-487a-814d-4cc7be76e460.

Question options can be fetched with /questionOptions request. See documentation for more information.

NOTE

  • You will can request the JSON template to upload the recipients in correct form
  • Template can be requested with /getJSONExampleForImportRecipientJSONWithDemData
  • Fill in the data and upload by using JSON
  • Use allowDuplicates: boolean (true) as a key-value in body to allow duplicate emails.
  • Use isSubmit: boolean (true) as a key-value in body to submit recipients answers to report. Answers are submitted and recipients can not answer to survey.
  • Do NOT include empty answers in JSON. If you add line (question) it needs to include a response.

RESPONSES

status: OK

{"RecipientsAdded":["3a6188ee-d8a4-4e95-8c98-080f662df40b"],"ScheduledFileId":"00000000-0000-0000-0000-000000000000","Message":"1 out of 1 recipients uploaded successfully","IsFailed":false,"IsScheduled":false,"HasDetailedErrors":false,"DetailedErrors":null}