/survey/{id}/answer/email/invite

put

https://my.surveypal.com/api/rest/survey/{id}/answer/email/invite

Send an email invitation to the survey.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

int64

required

Target survey id

Query Params

string

required

The answer email address.

unique

boolean

Defaults to false

The answer email address is required to be unique among the survey.

anonymous

boolean

Defaults to false

The answer email address is shown anonymously in the results.

localeId

string

Defaults to null

The answer language identifier. If survey doesn't contain specified language then first language will be selected. https://developer.surveypal.com/reference/locale-id-parameter

meta

string

A JSON array of meta information for the answer. https://developer.surveypal.com/reference/meta-parameter

author

string

Defaults to [email protected]

The invitation sender name. Sender address is always [email protected]

replyTo

string

Defaults to [email protected]

The invitation reply to email address.

subject

string

required

The invitation subject.

message

string

The invitation message.

sendAt

string

Defaults to now

The date and time when to send the invitation. https://developer.surveypal.com/reference/timestamp-parameter

Headers

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

Language

Credentials

Basic

base64

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

text/plain

200200

201201

300300