generate_distribution_links: Generate survey distribution links

In ppssphysics/QualtricsInR: Wrapper for Qualtrics v3 API references

Description

Create a distribution without sending any emails. The created distribution will be of type "GeneratedInvite". The survey must be active before you can generate a distribution invite. Refer to the documentation below for further information regarding usage of this API's result.

Usage

generate_distribution_links(
  survey_id,
  mailinglist_id,
  description = "Generated Links",
  linktype = "Individual",
  action = "CreateDistribution",
  expirationdate = NULL
)

Arguments

survey_id	the survey id
mailinglist_id	the mailing list id
description	name of the created ditribution (default is Generated Links)
linktype	the link type (default is Individual. Can be Multiple or Anonymous)
action	default is CreateDistribution. To generate transaction distribution links, value must be "CreateTransactionBatchDistribution"
expirationdate	the id of survey

Details

To retrieve the actual links, use the 'list_distribution_links' call.

Value

The id of the created distribution

Examples

## Not run: 
 generate_distribution_links(
   "SV_erkBAsHrvoJyeYB",
   "ML_7aoriSKinHh8MfP")
generate_distribution_links(
   "SV_erkBAsHrvoJyeYB",
   "ML_7aoriSKinHh8MfP", 
   "Survey Respondents Generated Links"
   "Multiple"

## End(Not run)

ppssphysics/QualtricsInR documentation built on Aug. 30, 2021, 8:12 a.m.