This is the endpoint used for adding larger batches of recipients to a survey. It has a limitation of 1000 requests per minute which is being reset every minute. Valid Survey id for existing survey needs to be provided.
If your request is made before the previous one has been handled, you will get a CONFLICT error.
We automatically filter out duplicate emails and prevent the same email being uploaded and sent more than once every 10 minutes.
If adding metatags by score type (e.g. thank_you_note_promoter, thank_you_note_passive, thank_you_note_detractor) they will work only if 'Customise based on score' switch is enabled within the web interface (on the design step of the survey).
For thank_you_link_url and thank_you_link_note to work, you will also need to enable the 'Add a link' switch in the web interface.
Using this endpoint, you can also include properties and metatags
You can only add recipients using our API to our email survey
{
"survey_id": "RXpqTHZLTVNYU29nQnNzQ3V1VVgveEdmNTJTK2VheXNt",
"send_at": "2018-01-01T09:00:00",
"survey_recipients": [
{
"recipient": {
"identity": "[email protected]",
"identity_type": "email",
"first_name": "test_first_name",
"last_name": "test_last_name",
"properties": [
{"name": "country", "value": "Germany"},
{"name": "gender", "value": "male"}
],
"metatags": {
"survey_question": "How likely are you to recommend %[question subject] test_first_name?",
"question_subject": "metatags",
"request_for_comment_all": "Tell us a bit more about why you chose %[score] for metatags",
"thank_you_link_text_all": "example text",
"thank_you_link_url_all": "www.example.com",
"thank_you_note_all": "Thanks for your feedback!"
}
}
},
{
"recipient": {
"identity": "[email protected]",
"identity_type": "email",
"first_name": "test_first_name2",
"last_name": "test_last_name2",
"properties": [
{"name": "country", "value": "Germany"},
{"name": "gender", "value": "male"}
],
"metatags": {
"survey_question": "How likely are you to recommend %[question subject] test_first_name?",
"question_subject": "metatags",
"request_for_comment_all": "Tell us a bit more about why you chose %[score] for metatags",
"thank_you_link_text_all": "example text",
"thank_you_link_url_all": "www.example.com",
"thank_you_note_all": "Thanks for your feedback!"
}
}
}
]
}
Response attributes
| Attribute | Type | Description |
|---|---|---|
| status | string | Request status. |