{"_id":"54a0ee8858c49f0b00140caa","parentDoc":null,"user":"5474380459fade080004c91d","version":{"_id":"5474381b59fade080004c923","project":"5474381b59fade080004c920","__v":12,"createdAt":"2014-11-25T08:04:43.418Z","releaseDate":"2014-11-25T08:04:43.418Z","categories":["5474381b59fade080004c924","5474387f59fade080004c927","547d639078fd57080023cb81","549eb883b67f031400a5dc0e","54c87c8bab03760d00c8e4ec","54ca1480eb42170d0045d3c6","54ca1539dd5cf30d00c35135","560e634e59cb8d0d0015cce1","560e7bfc59cb8d0d0015ccfb","562531976ff1010d009b16f0","57c0378264ebf60e006886d9","57c037912588020e004b5c8e"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"","version_clean":"1.0.0","version":"1.0"},"project":"5474381b59fade080004c920","__v":1,"category":{"_id":"547d639078fd57080023cb81","__v":56,"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"],"project":"5474381b59fade080004c920","version":"5474381b59fade080004c923","sync":{"url":"","isSync":false},"reference":false,"createdAt":"2014-12-02T07:00:32.464Z","from_sync":false,"order":1,"slug":"endpoints","title":"Endpoints"},"editedParams2":true,"editedParams":true,"githubsync":"","updates":[],"next":{"pages":[],"description":""},"createdAt":"2014-12-29T06:02:48.816Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"examples":{"codes":[]},"method":"post","results":{"codes":[{"name":"","code":"{ \"emailTaskId\":130695846 }","language":"json","status":200}]},"settings":"","auth":"required","params":[{"_id":"54a0e7cd58c49f0b00140c9a","ref":"","in":"path","required":true,"desc":"Answer id","default":"","type":"int","name":"id"},{"_id":"54a0ed90b9c6160b00b93de8","ref":"","in":"query","required":false,"desc":"The date and time when the reminder is scheduled to sent.  http://developer.surveypal.com/v1.0/docs/timestamp-parameter","default":"now","type":"string","name":"sendAt"},{"_id":"54a0ee8858c49f0b00140cb0","ref":"","in":"query","required":false,"desc":"The email recipient filter. https://dash.readme.io/project/surveypal/v1.0/docs/reminder-answer-state-parameter","default":"incomplete","type":"string","name":"filter"},{"_id":"54a0ee8858c49f0b00140caf","ref":"","in":"query","required":false,"desc":"The language identifier. If survey doesn't contain specified language then request will fail. http://developer.surveypal.com/v1.0/docs/locale-id-parameter","default":"","type":"string","name":"localeId"},{"_id":"58085da8b2524d0f0035062a","ref":"","in":"query","required":false,"desc":"The sender profile added to the answer","default":"","type":"long","name":"senderProfileId"},{"_id":"54a0ee8858c49f0b00140cae","ref":"","in":"query","required":false,"desc":"The email author name and email address.","default":"noreply:::at:::surveypal.com","type":"string","name":"author"},{"_id":"54a0ee8858c49f0b00140cad","ref":"","in":"query","required":false,"desc":"The email reply to address.","default":"noreply@surveypal.com","type":"string","name":"replyTo"},{"_id":"54a0ee8858c49f0b00140cac","ref":"","in":"query","required":true,"desc":"The email subject.","default":"","type":"string","name":"subject"},{"_id":"54a0ee8858c49f0b00140cab","ref":"","in":"query","required":false,"desc":"The email message.","default":"","type":"string","name":"message"}],"url":"/answer/:id/sendReminder"},"isReference":false,"order":26,"body":"Schedules an invitation email for the answer. Can target multiple email answers at the same time using filter and localeId params.\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"$.ajax({\\n  method: \\\"POST\\\",\\n  url: 'https://my.surveypal.com/api/rest/answer/:id/sendReminder?sendAt=:sendAt&filter=:filter&located=:located&author=:author&replyTo=:replyTo&subject=:subject&message=:message',\\n  headers: {\\n    \\\"X-Auth-Token\\\": \\\"YOUR-TOKEN\\\",\\n    \\\"Accept\\\": \\\"application/json\\\"\\n  }\\n});\",\n      \"language\": \"javascript\",\n      \"name\": \"jQuery\"\n    },\n    {\n      \"code\": \"curl -i -X POST \\\\\\n   -H \\\"X-Auth-Token:YOUR-TOKEN\\\" \\\\\\n   -H \\\"Accept:application/json\\\" \\\\\\n 'https://my.surveypal.com/api/rest/answer/:id/sendReminder?sendAt=:sendAt&filter=:filter&located=:located&author=:author&replyTo=:replyTo&subject=:subject&message=:message'\",\n      \"language\": \"curl\",\n      \"name\": null\n    }\n  ]\n}\n[/block]","excerpt":"Send a reminder email to the answer.","slug":"answeridsendreminder","type":"endpoint","title":"/answer/{id}/sendReminder"}

post/answer/{id}/sendReminder

Send a reminder email to the answer.

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Path Params

id:
required
integer
Answer id

Query Params

sendAt:
stringnow
The date and time when the reminder is scheduled to sent. http://developer.surveypal.com/v1.0/docs/timestamp-parameter
filter:
stringincomplete
The email recipient filter. https://dash.readme.io/project/surveypal/v1.0/docs/reminder-answer-state-parameter
localeId:
string
The language identifier. If survey doesn't contain specified language then request will fail. http://developer.surveypal.com/v1.0/docs/locale-id-parameter
senderProfileId:
long
The sender profile added to the answer
author:
stringnoreply@surveypal.com
The email author name and email address.
replyTo:
stringnoreply@surveypal.com
The email reply to address.
subject:
required
string
The email subject.
message:
string
The email message.

Result Format


Documentation

Schedules an invitation email for the answer. Can target multiple email answers at the same time using filter and localeId params. [block:code] { "codes": [ { "code": "$.ajax({\n method: \"POST\",\n url: 'https://my.surveypal.com/api/rest/answer/:id/sendReminder?sendAt=:sendAt&filter=:filter&located=:located&author=:author&replyTo=:replyTo&subject=:subject&message=:message',\n headers: {\n \"X-Auth-Token\": \"YOUR-TOKEN\",\n \"Accept\": \"application/json\"\n }\n});", "language": "javascript", "name": "jQuery" }, { "code": "curl -i -X POST \\\n -H \"X-Auth-Token:YOUR-TOKEN\" \\\n -H \"Accept:application/json\" \\\n 'https://my.surveypal.com/api/rest/answer/:id/sendReminder?sendAt=:sendAt&filter=:filter&located=:located&author=:author&replyTo=:replyTo&subject=:subject&message=:message'", "language": "curl", "name": null } ] } [/block]

User Information

Try It Out

post
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}