{ "opencollection": "1.0.0", "info": { "name": "GetResponse APIv3 Autoresponders", "version": "3.2026-07-28T07:58:55+00:00" }, "items": [ { "info": { "name": "Autoresponders", "type": "folder" }, "items": [ { "info": { "name": "Get a single autoresponder by its ID", "type": "http" }, "http": { "method": "GET", "url": "https://api.getresponse.com/v3/autoresponders/:autoresponderId", "params": [ { "name": "autoresponderId", "value": "Q", "type": "path", "description": "The autoresponder ID." }, { "name": "fields", "value": "", "type": "query", "description": "List of fields that should be returned. Id is always returned. Fields should be separated by comma" } ], "auth": { "type": "apikey", "key": "X-Auth-Token", "value": "{{X-Auth-Token}}", "placement": "header" } }, "docs": "Get a single autoresponder by its ID" }, { "info": { "name": "Update autoresponder", "type": "http" }, "http": { "method": "POST", "url": "https://api.getresponse.com/v3/autoresponders/:autoresponderId", "params": [ { "name": "autoresponderId", "value": "Q", "type": "path", "description": "The autoresponder ID." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-Auth-Token", "value": "{{X-Auth-Token}}", "placement": "header" } }, "docs": ">\n**The action-based autoresponder feature has been migrated over to marketing automation. Your existing autoresponders are\nnow converted into workflows. You can no longer create and update action-based autoresponders using our API.**\n\nThis method allows you to update an autoresponder. The same rules as in creating an autoresponder apply.\n" }, { "info": { "name": "Delete autoresponder.", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.getresponse.com/v3/autoresponders/:autoresponderId", "params": [ { "name": "autoresponderId", "value": "Q", "type": "path", "description": "The autoresponder ID." } ], "auth": { "type": "apikey", "key": "X-Auth-Token", "value": "{{X-Auth-Token}}", "placement": "header" } }, "docs": "Delete autoresponder." }, { "info": { "name": "The statistics for a single autoresponder", "type": "http" }, "http": { "method": "GET", "url": "https://api.getresponse.com/v3/autoresponders/:autoresponderId/statistics", "params": [ { "name": "autoresponderId", "value": "Q", "type": "path", "description": "The autoresponder ID." }, { "name": "query[groupBy]", "value": "", "type": "query", "description": "Group results by time interval" }, { "name": "query[createdOn][from]", "value": "", "type": "query", "description": "Count data from this date" }, { "name": "query[createdOn][to]", "value": "", "type": "query", "description": "Count data to this date" }, { "name": "fields", "value": "", "type": "query", "description": "List of fields that should be returned. Id is always returned. Fields should be separated by comma" }, { "name": "perPage", "value": "", "type": "query", "description": "Requested number of results per page" }, { "name": "page", "value": "", "type": "query", "description": "Page number" } ], "auth": { "type": "apikey", "key": "X-Auth-Token", "value": "{{X-Auth-Token}}", "placement": "header" } }, "docs": ">\nThis requst returns the statistics summary for a single given autoresponder. As in all statistics, you can change the date and time range (hourly daily monthly or total). Keep in mind\nthat all statistics date ranges are given in standard UTC period type objects. ([See ISO 8601 standard](http://en.wikipedia.org/wiki/ISO_8601#Time_intervals))\n\n(https://app.getresponse.com/statistics.html?t=followup#total).\n You can filter the resource using criteria specified as `query[*]`. You can provide mult" }, { "info": { "name": "Get the autoresponder thumbnail", "type": "http" }, "http": { "method": "GET", "url": "https://api.getresponse.com/v3/autoresponders/:autoresponderId/thumbnail", "params": [ { "name": "autoresponderId", "value": "Q", "type": "path", "description": "The autoresponder ID." }, { "name": "size", "value": "", "type": "query", "description": "The size of the autoresponder thumbnail" } ], "auth": { "type": "apikey", "key": "X-Auth-Token", "value": "{{X-Auth-Token}}", "placement": "header" } }, "docs": "Get the autoresponder thumbnail" }, { "info": { "name": "Get the list of autoresponders.", "type": "http" }, "http": { "method": "GET", "url": "https://api.getresponse.com/v3/autoresponders", "params": [ { "name": "query[subject]", "value": "", "type": "query", "description": "Search autoresponder by subject" }, { "name": "query[name]", "value": "", "type": "query", "description": "Search autoresponder by name" }, { "name": "query[status]", "value": "", "type": "query", "description": "Search autoresponder by status" }, { "name": "query[createdOn][from]", "value": "", "type": "query", "description": "Search autoresponder created from this date" }, { "name": "query[createdOn][to]", "value": "", "type": "query", "description": "Search autoresponder created to this date" }, { "name": "query[campaignId]", "value": "", "type": "query", "description": "Search autoresponder by campaign ID" }, { "name": "sort[name]", "value": "", "type": "query", "description": "Sort by name" }, { "name": "sort[subject]", "value": "", "type": "query", "description": "Sort by subject" }, { "name": "sort[dayOfCycle]", "value": "", "type": "query", "description": "Sort by cycle day" }, { "name": "sort[delivered]", "value": "", "type": "query", "description": "Sort by delivered" }, { "name": "sort[openRate]", "value": "", "type": "query", "description": "Sort by open rate" }, { "name": "sort[clickRate]", "value": "", "type": "query", "description": "Sort by click rate" }, { "name": "sort[createdOn]", "value": "", "type": "query", "description": "Sort by date" }, { "name": "fields", "value": "", "type": "query", "description": "List of fields that should be returned. Id is always returned. Fields should be separated by comma" }, { "name": "perPage", "value": "", "type": "query", "description": "Requested number of results per page" }, { "name": "page", "value": "", "type": "query", "description": "Page number" } ], "auth": { "type": "apikey", "key": "X-Auth-Token", "value": "{{X-Auth-Token}}", "placement": "header" } }, "docs": "You can filter the resource using criteria specified as `query[*]`. You can provide multiple criteria, to use AND logic. You can sort the resource using parameters specified as `sort[*]`. You can specify multiple fields to sort by." }, { "info": { "name": "Create autoresponder", "type": "http" }, "http": { "method": "POST", "url": "https://api.getresponse.com/v3/autoresponders", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-Auth-Token", "value": "{{X-Auth-Token}}", "placement": "header" } }, "docs": ">\n**The action-based autoresponder feature has been migrated over to marketing automation. Your existing autoresponders are\nnow converted into workflows. You can no longer create and update action-based autoresponders using our API.**\n\nThis request allows you to create an autoresponder. Remember to select the proper `sendSettings` - depending on `type` you need to fill corresponding setting (eg. if you selected type `delay`, then you MUST fill `delayInHours` field).\n" }, { "info": { "name": "The statistics for all autoresponders", "type": "http" }, "http": { "method": "GET", "url": "https://api.getresponse.com/v3/autoresponders/statistics", "params": [ { "name": "query[groupBy]", "value": "", "type": "query", "description": "Group results by time interval" }, { "name": "query[autoreponderId]", "value": "", "type": "query", "description": "The list of autoresponder resource IDs (string separated with '')" }, { "name": "query[campaignId]", "value": "", "type": "query", "description": "The list of campaign resource IDs (string separated with '')" }, { "name": "query[createdOn][from]", "value": "", "type": "query", "description": "Count data from this date" }, { "name": "query[createdOn][to]", "value": "", "type": "query", "description": "Count data to this date" }, { "name": "fields", "value": "", "type": "query", "description": "List of fields that should be returned. Id is always returned. Fields should be separated by comma" }, { "name": "perPage", "value": "", "type": "query", "description": "Requested number of results per page" }, { "name": "page", "value": "", "type": "query", "description": "Page number" } ], "auth": { "type": "apikey", "key": "X-Auth-Token", "value": "{{X-Auth-Token}}", "placement": "header" } }, "docs": ">\nThis returns the statistics summary for selected autoresponders. You can select them by specifying the autoresponder or campaign IDs.\nAs in all statistics, you can change the date and time range (hourly daily monthly or total). Keep in mind\nthat all statistics date ranges are given in standard UTC period type objects. ([See ISO 8601 standard](http://en.wikipedia.org/wiki/ISO_8601#Time_intervals))\n\n(https://app.getresponse.com/statistics.html?t=followup#total).\n You can filter the resource usi" } ] } ], "bundled": true }