Send Email
POST https://rest.webropolsurveys.com/api/v1/surveys/{{SurveyId}}/send/email
Sends an email to the recipients. You can define following details in body.
TemplateId can be requested with GET /emailtemplates
{
"Filter": "SendToAll", //Allowed values: 'SendToAll', 'SendToNew', 'NotAnswered', 'Answered'
"EmailBody": "Please respond to my survey", //HTML is allowed
"EmailSubject": "Survey Invitation",
"TemplateId": "00000000-0000-0000-0000-000000000000", //Optional email template to be used
"RecipientGroupId": "00000000-0000-0000-0000-000000000000" //Optional recipient group,
"LimitAnsweringDays": 0 //optional
}
Request Body
{"Filter"=>"SendToAll", "EmailBody"=>"Hello, please respond to the survey. Link below.", "EmailSubject"=>"Please respond to survey!", "LimitAnsweringDays"=>0}
HEADERS
Key | Datatype | Required | Description |
---|---|---|---|
Content-Type | string |
RESPONSES
status: OK
{"EmailSent":3}