{"metadata":{"image":[],"title":"","description":""},"api":{"url":"/survey/:id/answer/email/invite/batch","auth":"required","method":"put","params":[{"name":"id","type":"string","default":"","desc":"Survey id","required":true,"in":"path","ref":"","_id":"54a0f26858c49f0b00140cbf"},{"name":"email","type":"string","default":"false","desc":"The answer email address.","required":true,"in":"body","ref":"","_id":"54a0f22058c49f0b00140cbb"},{"name":"meta","type":"string","default":"","desc":"A JSON array of meta information for the answer. http://developer.surveypal.com/v1.0/docs/meta-parameter","required":false,"in":"body","ref":"","_id":"54a0f31658c49f0b00140cc3"},{"name":"anonymous","type":"boolean","default":"false","desc":"The answer email address is shown anonymously in the results.","required":false,"in":"query","ref":"","_id":"5efc52c366929300371e1d40"},{"name":"unique","type":"boolean","default":"true","desc":"The answer email address is required to be unique among the survey.","required":false,"in":"query","ref":"","_id":"5efc52c366929300371e1d3f"},{"name":"subject","type":"string","default":"","desc":"The invitation subject. Mandatory only in first request if subject is not saved to the survey.","required":false,"in":"query","ref":"","_id":"5efc52c366929300371e1d3e"},{"name":"message","type":"string","default":"","desc":"The invitation message. Mandatory only in first request if message is not saved to the survey.","required":false,"in":"query","ref":"","_id":"5efc52c366929300371e1d3d"},{"name":"localeId","type":"string","default":"","desc":"The answer language identifier. If survey doesn't contain specified language then first language will be selected. http://developer.surveypal.com/v1.0/docs/locale-id-parameter","required":false,"in":"query","ref":"","_id":"5efc52c366929300371e1d3c"},{"name":"author","type":"string","default":"noreply:::at:::surveypal.com","desc":"The invitation sender name. Sender address is always [email protected]","required":false,"in":"query","ref":"","_id":"5efc56ab09f59d00112c04f1"},{"name":"replyTo","type":"string","default":"[email protected]","desc":"The invitation reply to email address.","required":false,"in":"query","ref":"","_id":"5efc56ab09f59d00112c04f0"},{"name":"sendAt","type":"string","default":"now","desc":"The date and time when to send the invitation. http://developer.surveypal.com/v1.0/docs/timestamp-parameter","required":false,"in":"query","ref":"","_id":"5efc56ab09f59d00112c04ef"}],"results":{"codes":[{"status":200,"language":"json","code":"{\n    \"current\": [],\n    \"new\": [\n        {\n            \"answerId\": 1222644916,\n            \"hash\": \"r3QJoof9pbj8G8TJztaaWtANm2x05Pkow7FGv0shBPQloowawoHToA2u22QYUIeV\",\n            \"email\": \"[email protected]\",\n            \"url\": \"https://q.surveypal.com/inv3?recipient=identified-1222644916-r3QJoof9pbj8G8TJztaaWtANm2x05Pk227FGv0shBPQloowawoHToA2ut9Q22IeV-PrivateLinkDoNotShare\",\n            \"emailTaskId\": 1222633171\n        },\n        {\n            \"answerId\": 1222644917,\n            \"hash\": \"cUlU_z9eV-9ZPlLMSrJ3189rxrD7RFY6waISOyY9oo4TASCU0hQocRiovoRrip11\",\n            \"email\": \"[email protected]\",\n            \"url\": \"https://q.surveypal.com/inv3?recipient=identified-1222644917-cUlU_z9eV-9ZPlLMSrJ3189rxrD722Y6waISOyY9oo4TASCU0hQocRiovoR22poF-PrivateLinkDoNotShare\",\n            \"emailTaskId\": 1222633171\n        }\n    ]\n}","name":""}]},"examples":{"codes":[{"code":"var settings = {\n  \"url\": \"https://my.surveypal.com/api/rest/survey/1155092947/answer/email/invite/batch?unique=:unique&anonymous=:anonymous&localeId=:localeId&author=:author&replyTo=:replyTo&subject=:subject&message=:message&sendAt=:sendAt\",\n  \"method\": \"PUT\",\n  \"timeout\": 0,\n  \"headers\": {\n    \"X-Auth-Token\": \"YOURTOKEN\",\n    \"Accept\": \"application/json\",\n  },\n  \"data\": JSON.stringify([{\"email\":\"[email protected]lykamu.com\",\"meta\":[{\"key\":\"firstname\",\"value\":\"Mikko\"},{\"key\":\"lastname\",\"value\":\"Mäkelä\"}]},{\"email\":\"[email protected]\",\"meta\":[{\"key\":\"firstname\",\"value\":\"Mikko\"},{\"key\":\"lastname\",\"value\":\"Valoisa\"}]}]),\n};\n\n$.ajax(settings).done(function (response) {\n  console.log(response);\n});","language":"javascript","name":"jQuery"},{"code":"curl --location --request PUT 'https://my.surveypal.com/api/rest/survey/1155092947/answer/email/invite/batch?&unique=:unique&anonymous=:anonymous&localeId=:localeId&author=:author&replyTo=:replyTo&subject=:subject&message=:message&sendAt=:sendAt' \\\n--header 'X-Auth-Token: YOURTOKEN' \\\n--header 'Accept: application/json' \\\n--data-raw '\n[\n{\n\"email\":\"[email protected]\",\n\"meta\":[{\"key\":\"firstname\",\"value\":\"Mikko\"},{\"key\":\"lastname\",\"value\":\"Mäkelä\"}]\n},\n{\n\"email\":\"[email protected]\",\n\"meta\":[{\"key\":\"firstname\",\"value\":\"Mikko\"},{\"key\":\"lastname\",\"value\":\"Valoisa\"}]\n}\n]'","language":"curl"}]},"settings":""},"next":{"description":"","pages":[]},"title":"/survey/{id}/answer/email/invite/batch","type":"endpoint","slug":"survey-id-answer-email-invite-batch","excerpt":"Send batch of email invitations to the survey.","body":"Will send batch of email invitation to the survey. Email subject and message are freely editable. If you don't send message then invitation message will be the one what you have saved to the survey.","updates":[],"order":14,"isReference":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"54a0f38558c49f0b00140cca","project":"5474381b59fade080004c920","__v":7,"version":{"version":"1.0","version_clean":"1.0.0","codename":"","is_stable":true,"is_beta":false,"is_hidden":false,"is_deprecated":false,"categories":["5474381b59fade080004c924","5474387f59fade080004c927","547d639078fd57080023cb81","549eb883b67f031400a5dc0e","54c87c8bab03760d00c8e4ec","54ca1480eb42170d0045d3c6","54ca1539dd5cf30d00c35135","560e634e59cb8d0d0015cce1","560e7bfc59cb8d0d0015ccfb","562531976ff1010d009b16f0","57c0378264ebf60e006886d9","57c037912588020e004b5c8e"],"_id":"5474381b59fade080004c923","createdAt":"2014-11-25T08:04:43.418Z","releaseDate":"2014-11-25T08:04:43.418Z","project":"5474381b59fade080004c920","__v":12},"createdAt":"2014-12-29T06:24:05.115Z","editedParams":true,"editedParams2":true,"githubsync":"","parentDoc":null,"user":"5474380459fade080004c91d","category":{"sync":{"isSync":false,"url":""},"pages":["547d6ab078fd57080023cb9c","547d6ad678fd57080023cba0","547d6cf12eaee50800ed11c5","547d70b678fd57080023cbaa","547d70e878fd57080023cbac","549eb4c87483040b001e9f79","549eb781b67f031400a5dc09","54a0e7cd58c49f0b00140c99","54a0e80b58c49f0b00140c9c","54a0e88cb9c6160b00b93dce","54a0e8ffb9c6160b00b93dd7","54a0ebd2b9c6160b00b93ddf","54a0ec11b9c6160b00b93de0","54a0ec62b9c6160b00b93de3","54a0ec8d58c49f0b00140c9f","54a0ecad58c49f0b00140ca1","54a0ecd958c49f0b00140ca2","54a0ed2cb9c6160b00b93de4","54a0ed5f58c49f0b00140ca3","54a0ed90b9c6160b00b93de7","54a0edc658c49f0b00140ca5","54a0eded58c49f0b00140ca8","54a0ee1b58c49f0b00140ca9","54a0ee8858c49f0b00140caa","54a0eed758c49f0b00140cb1","54a0f22058c49f0b00140cb9","54a0f25a58c49f0b00140cbd","54a0f2a858c49f0b00140cc0","54a0f2c458c49f0b00140cc1","54a0f31658c49f0b00140cc2","54a0f35b58c49f0b00140cc4","54a0f38558c49f0b00140cca","54a0f3b058c49f0b00140ccc","54a0f407b9c6160b00b93de9","54c63654f52b710d00d643d6","54c636cdf0320f0d00ac9b4e","54c636ef355b790d003c1223","54c63704f52b710d00d643d9","54c63726f52b710d00d643da","54c884cde317000d007c2841","54c88669ab03760d00c8e4ee","54c88704e317000d007c2844","54c89b40353f830d00678dc6","54c89bc119d1910d004feb3d","54c8b7b54574700d00f015ee","54c8bac50174630d00efa81a","54c8bd4e0174630d00efa81f","54cb3ffd61698d0d00baf765","5608ca086d8c440d000c79d1","5609326031beb60d001b65b0","560a273587b71d0d000d3a40","560a2d17ee8a910d0072f75d","56125a9a0157131900b45858","56125bf5ad4dab0d0064d288","56125f152afc821700a5b1f9","561b92d5868acd0d0043ad8a"],"title":"Endpoints","slug":"endpoints","order":1,"from_sync":false,"reference":false,"_id":"547d639078fd57080023cb81","__v":56,"createdAt":"2014-12-02T07:00:32.464Z","project":"5474381b59fade080004c920","version":"5474381b59fade080004c923"}}