{"_id":"54a0e80b58c49f0b00140c9c","__v":0,"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,"parentDoc":null,"project":"5474381b59fade080004c920","user":"5474380459fade080004c91d","editedParams":true,"githubsync":"","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"},"metadata":{"title":"","description":"","image":[]},"updates":[],"next":{"pages":[],"description":""},"createdAt":"2014-12-29T05:35:07.827Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[{"name":null,"code":"","language":"json","status":200}]},"method":"post","auth":"required","params":[{"_id":"54a0e7cd58c49f0b00140c9a","ref":"","in":"path","required":true,"desc":"Email task id","default":"","type":"int","name":"id"}],"url":"/emailtask/:id/activate"},"isReference":false,"order":23,"body":"Activates the email task if it is an draft and it contains email templates. Empty email task cannot be activated because there is no reason to run it.\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"$.ajax({\\n  method: \\\"POST\\\",\\n  url: 'https://my.surveypal.com/api/rest/emailtask/:id/activate',\\n  headers: {\\n    \\\"X-Auth-Token\\\": \\\"YOUR-TOKEN\\\",\\n    \\\"Accept\\\": \\\"application/json\\\"\\n  }\\n});\",\n      \"language\": \"text\",\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/emailtask/:id/activate'\",\n      \"language\": \"curl\"\n    }\n  ]\n}\n[/block]","excerpt":"Activates the email task.","slug":"emailtaskemailtaskidactivate","type":"endpoint","title":"/emailtask/{id}/activate"}

post/emailtask/{id}/activate

Activates the email task.

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Path Params

id:
required
integer
Email task id

Documentation

Activates the email task if it is an draft and it contains email templates. Empty email task cannot be activated because there is no reason to run it. [block:code] { "codes": [ { "code": "$.ajax({\n method: \"POST\",\n url: 'https://my.surveypal.com/api/rest/emailtask/:id/activate',\n headers: {\n \"X-Auth-Token\": \"YOUR-TOKEN\",\n \"Accept\": \"application/json\"\n }\n});", "language": "text", "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/emailtask/:id/activate'", "language": "curl" } ] } [/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 }}