create_reminder_distribution: Create a reminder distribution for an existing email...

Description Usage Arguments Details Value Examples

View source: R/distributions.R

Description

Based on an existing email distribution, create a reminder to take a survey for recipients with non completed surveys. Recipients who have opted out will not receive the reminder.

Usage

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
create_reminder_distribution(
  parent_distribution_id,
  library_id,
  message_id,
  subject = "Reminder - Participate to the survey",
  send_date = paste0(Sys.Date() + 2, "T00:00:00Z"),
  from_email = "noreply@qualtrics.com",
  from_name = "Qualtrics",
  reply_to_email = "noreply@qualtrics.com"
)

Arguments

parent_distribution_id

id of the library item

library_id

Library ID of the message

message_id

id of the message item

subject

email subject, default is "Reminder - Participate to the survey"

send_date

date for distribution to be sent (default to time + 1 day)

from_email

sender email, default is noreply@qualtrics.com

from_name

appearing sender name, default is Qualtrics

reply_to_email

reply email, default is noreply@qualtrics.com

Details

The parent distribution id can be found using the 'list_distributions' call. The sender email parameter can only be sent from another email if the organization authorizes a send on its behalf.

Value

The reminder distribution id

Examples

1
2
3
4
5
6
7
8
## Not run: 
  create_reminder_distribution(
    "EMD_6yYmF6vopfUz4gn",
    library_id = "UR_0NXtl92JJWqfWcJ",
    message_id = "MS_0fddN2xI3J0nGQZ"
)

## End(Not run)

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