Returns statistics summary about selected autoresponders. You can select them by specifying autoresponderId's or campaignId's. Like in all statistical methods you can change grouping scope (hourly, daily, monthly or total). You should also remember that all statistics periods are given in standart UTC period type objects. (See ISO 8601 standard)

(https://app.getresponse.com/statistics.html?t=followup#total)

Returns status code

200

Request url

/autoresponders/statistics?query[groupBy]=total&query[autoresponderId]=p,V&page=1&perPage=100

Request params

Field nameField typeField description
query (required)hashUsed to search only resources that meets criteria. You can specify multiple parameters, then it uses AND logic. You must specified at least one following parameters: autoresponderId, campaignId
KeyPossible values if fixed
groupBytotal,hour,day,month
autoresponderIdList of autoresponder resource ids. (string separated with ",")
campaignIdList of campaign resource ids. (string separated with ",")
createdOn[from]Date YYYY-mm-dd
createdOn[to]Date YYYY-mm-dd
fieldsstringList of fields that should be returned. Id is always returned. Fields should be separated by comma
pageintegerSpecify which page of results return.
perPageintegerSpecify how many results per page should be returned

Example Response

[
    {
        "timeInterval": "2014-09-20T00:00:00+0000/P2M18DT10H0M0S",
        "sent": "2",
        "totalOpened": "4",
        "uniqueOpened": "6",
        "totalClicked": "2",
        "uniqueClicked": "0",
        "goals": "0",
        "uniqueGoals": "0",
        "forwarded": "0",
        "unsubsribed": "0",
        "bounced": "0",
        "complaints": "0"
    }
]

The action-based autoresponder feature has been migrated over to marketing automation. Your existing autoresponders are now converted into workflows. You can no longer create and update action-based autoresponders using our API. What happened?

This request allows you to create autoresponder. You need to remember to select proper sendSetting - depending on 'type' you need to fill coresponding setting (eg. if you selected type 'delay' then you MUST fill 'delayInHours' field).

Returns status code

201

Example Request Body

{
    "name": "Message 2",
    "subject": "test12",
    "status": "enabled",
    "fromField": {
        "fromFieldId": "V"
    },
    "replyTo": null,
    "content": {
        "plain": null,
        "html": "<h1>test 12</h1><p>Some test</p>"
    },
    "flags": [],
    "sendSettings": {
        "type": "delay",
        "delayInHours": "21",
        "sendAtHour": null,
        "recurrence": "false",
        "timeTravel": "false",
        "excludedDaysOfWeek": [
            "Monday",
            "Tuesday",
            "Thursday",
            "Sunday"
        ]
    },
    "triggerSettings": {
        "type": "onday",
        "dayOfCycle": "13",
        "selectedCampaigns": [
            "V"
        ]
    }
}

Body params

Field nameField typeField description
namestringName of autoresponder (min. 2 chars , max. 128 chars)
subject (required)stringSubject of message (min. 2 chars , max. 128 chars)
status (required)stringStatus of autoresponder: enabled, disabled
editorstringHow message was created: 'custom' - custom made message, 'plain' - plain content, 'getresponse' - via GetResponse editor
fromFieldcollectionEmail from field
Field nameField typeField description
fromFieldIdstringId of fromField which will be used as email from field
replyTocollectionEmail that will be used as reply address
Field nameField typeField description
fromFieldIdstringId of fromField which will be used as email from field
contentcollectionMessage contents
Field nameField typeField description
htmlstringHTML content of message (max.length 524288)
plainstringPlain text content equivalent of message (max.length 524288)
flagssetMessage flags. Allowed values: openrate, clicktrack and google_analytics
sendSettingscollectionHow message will be delivered to subscriber
Field nameField typeField description
type (required)stringTime when to send message. Possible values: signup, immediately, delay, custom
delayInHoursintegerHow many hours to delay message after trigger occured, format: 0-23
sendAtHourintegerSpecific hour on which message will be sent, format: 0-23
recurrencestringShoud message be send everytime trigger occurs (example: each click) Possible values: true, false
timeTravelstringShoud message be send in user or subscriber timeZone. Possible values: true, false
excludedDaysOfWeeksetDays of week which should be excluded for sendings (Message will be send next available day after trigger). Possible values: Monday, Tuesday, Wednesday, Thursday, Friday, Saturday, Sunday
triggerSettingscollectionConditions on which autoresponder will be triggered
Field nameField typeField description
typestringType of trigger. Possible values: onday
dayOfCyclestringFor onday type, day of autoresponder cycle. Required if type onday, format: 0-9999
selectedCampaignssetList of campaign Ids from which to search for subscribers, required if type onday or subscribed
selectedSegmentssetList of specific segment Ids from which to search for subscribers

Example Response

{
    "autoresponderId": "p",
    "href": "http://api.getresponse.com/v3/autoresponders/p",
    "name": "Message 2",
    "subject": "test12",
    "status": "active",
    "fromField": {
        "fromFieldId": "V",
        "href": "http://api.getresponse.com/v3/from-fields/V"
    },
    "replyTo": null,
    "createdOn": "2014-09-29T12:26:10+0000",
    "campaignId": "V",
    "content": {
        "plain": null,
        "html": "<h1>test 12</h1><p>Some test</p>"
    },
    "flags": [],
    "clickTracks": [
        {
            "clickTrackId": "c",
            "url": "http://example.com",
            "name": "http://example.com"
        }
    ],
    "sendSettings": {
        "type": "delay",
        "delayInHours": "21",
        "sendAtHour": null,
        "recurrence": "false",
        "timeTravel": "false",
        "excludedDaysOfWeek": [
            "Monday",
            "Tuesday",
            "Thursday",
            "Sunday"
        ]
    },
    "triggerSettings": {
        "type": "onday",
        "autoresponder": null,
        "newsletter": null,
        "clickTrackId": null,
        "goal": null,
        "custom": null,
        "action": null,
        "newCustomValue": null,
        "dayOfCycle": "13",
        "selectedCampaigns": [
            "V"
        ],
        "selectedSegments": []
    }
}

Possible Errors


This request returns statistics summary about exactly one given autoresponder. Like in all statistical methods you can change grouping scope (hourly, daily, monthly or total). You should also remember that all statistics periods are given in standard UTC period type objects. (See ISO 8601 standard)

(https://app.getresponse.com/statistics.html?t=followup#total)

Returns status code

200

Request url

/autoresponders/V/statistics?query[groupBy]=day&page=1&perPage=100

Request params

Field nameField typeField description
query (required)hashUsed to search only resources that meets criteria. You can specify multiple parameters, then it uses AND logic.
KeyPossible values if fixed
groupBytotal,hour,day,month
createdOn[from]Date YYYY-mm-dd
createdOn[to]Date YYYY-mm-dd
fieldsstringList of fields that should be returned. Id is always returned. Fields should be separated by comma
pageintegerSpecify which page of results return.
perPageintegerSpecify how many results per page should be returned

Example Response

[
    {
        "timeInterval": "2014-09-20T00:00:00+0000/P2M18DT10H0M0S",
        "sent": "2",
        "totalOpened": "4",
        "uniqueOpened": "6",
        "totalClicked": "2",
        "uniqueClicked": "0",
        "goals": "0",
        "uniqueGoals": "0",
        "forwarded": "0",
        "unsubsribed": "0",
        "bounced": "0",
        "complaints": "0"
    }
]

Returns status code

204

The action-based autoresponder feature has been migrated over to marketing automation. Your existing autoresponders are now converted into workflows. You can no longer create and update action-based autoresponders using our API. What happened?

This method allows you to update autoresponder. The same rules as in creating autoresponder apply.

 

Returns status code

201

Example Request Body

{
    "name": "Message 2",
    "subject": "test12",
    "status": "active",
    "fromField": {
        "fromFieldId": "V"
    },
    "replyTo": null,
    "createdOn": "2014-09-29T12:26:10+0000",
    "content": {
        "plain": null,
        "html": "<h1>test 12</h1><p>Some test</p>"
    },
    "flags": [],
    "sendSettings": {
        "type": "delay",
        "delayInHours": "21",
        "sendAtHour": null,
        "recurrence": "false",
        "timeTravel": "false",
        "excludedDaysOfWeek": [
            "Monday",
            "Tuesday",
            "Thursday",
            "Sunday"
        ]
    },
    "triggerSettings": {
        "type": "onday",
        "dayOfCycle": "13"
    }
}

Body params

Field nameField typeField description
namestringName of autoresponder (min. 2 chars , max. 128 chars)
subject (required)stringSubject of message (min. 2 chars , max. 128 chars)
status (required)stringStatus of autoresponder: active, inactive
editorstringHow message was created: 'custom' - custom made message,'plain' - plain content,'getresponse' - via gr editor]
fromFieldcollectionEmail from field
Field nameField typeField description
fromFieldIdstringId of fromField which will be used as email from field
replyTocollectionEmail that will be used as reply address
Field nameField typeField description
fromFieldIdstringId of fromField which will be used as email from field
contentcollectionMessage contents
Field nameField typeField description
htmlstringHTML content of message
plainstringPlain text content equivalent of message
flagssetMessage flags. Allowed values: openrate, clicktrack and google_analytics
sendSettingscollectionHow message will be delivered to subscriber
Field nameField typeField description
typestringTime when to send message. Possible values: signup, immediately, delay, custom
delayInHoursintegerHow many hours to delay message after trigger occured, format: 0-23
sendAtHourintegerSpecific hour on which message will be sent, format: 0-23
recurrencestringShoud message be send everytime trigger occurs (example: each click) Possible values: true, false
timeTravelstringShoud message be send in user or subscriber timeZone. Possible values: true, false
excludedDaysOfWeeksetDays of week which should be excluded for sendings (Message will be send next available day after trigger). Possible values: Monday, Tuesday, Wednesday, Thursday, Friday, Saturday, Sunday
triggerSettingscollectionConditions on which autoresponder will be triggered
Field nameField typeField description
typestringType of trigger. Possible values: onday
dayOfCyclestringFor onday type, day of autoresponder cycle, format: 0-9999.
selectedCampaignssetList of campaign Id from which to search for subscribers
selectedSegmentssetList of specific segment Ids from which to search for subscribers

Example Response

{
    "autoresponderId": "p",
    "href": "http://api.getresponse.com/v3/autoresponders/p",
    "name": "Message 2",
    "subject": "test12",
    "status": "active",
    "fromField": {
        "fromFieldId": "V",
        "href": "http://api.getresponse.com/v3/from-fields/V"
    },
    "replyTo": null,
    "createdOn": "2014-09-29T12:26:10+0000",
    "campaignId": "V",
    "content": {
        "plain": null,
        "html": "<h1>test 12</h1><p>Some test</p>"
    },
    "flags": [],
    "clickTracks": [
        {
            "clickTrackId": "c",
            "url": "http://example.com",
            "name": "http://example.com"
        }
    ],
    "sendSettings": {
        "type": "delay",
        "delayInHours": "21",
        "sendAtHour": null,
        "recurrence": "false",
        "timeTravel": "false",
        "excludedDaysOfWeek": [
            "Monday",
            "Tuesday",
            "Thursday",
            "Sunday"
        ]
    },
    "triggerSettings": {
        "type": "onday",
        "autoresponder": null,
        "newsletter": null,
        "clickTrackId": null,
        "goal": null,
        "custom": null,
        "action": null,
        "newCustomValue": null,
        "subscribeCampaign": null,
        "dayOfCycle": "13",
        "selectedCampaigns": [],
        "selectedSegments": []
    }
}

Possible Errors


Returns status code

200

Request url

/autoresponders/p?fields=sendSettings

Request params

Field nameField typeField description
fieldsstringList of fields that should be returned. Id is always returned. Fields should be separated by comma

Example Response

{
    "autoresponderId": "p",
    "href": "http://api.getresponse.com/v3/autoresponders/p",
    "name": "Message 2",
    "subject": "test12",
    "status": "active",
    "fromField": {
        "fromFieldId": "V",
        "href": "http://api.getresponse.com/v3/from-fields/V"
    },
    "replyTo": null,
    "createdOn": "2014-09-29T12:26:10+0000",
    "campaignId": "V",
    "content": {
        "plain": null,
        "html": "<h1>test 12</h1><p>Some test</p>"
    },
    "flags": [],
    "clickTracks": [
        {
            "clickTrackId": "K",
            "url": "http://example.com",
            "name": "http://example.com"
        }
    ],
    "sendSettings": {
        "type": "delay",
        "delayInHours": "21",
        "sendAtHour": null,
        "recurrence": "false",
        "timeTravel": "false",
        "excludedDaysOfWeek": [
            "Monday",
            "Tuesday",
            "Thursday",
            "Sunday"
        ]
    },
    "triggerSettings": {
        "type": "onday",
        "autoresponder": null,
        "newsletter": null,
        "clickTrackId": null,
        "goal": null,
        "custom": null,
        "action": null,
        "newCustomValue": null,
        "subscribeCampaign": null,
        "dayOfCycle": "13",
        "selectedCampaigns": [],
        "selectedSegments": []
    }
}

Returns status code

200

Request url

/autoresponders?query[name]=test&page=1&perPage=100&sort[name]=asc

Request params

Field nameField typeField description
queryhashUsed to search only resources that meets criteria. You can specify multiple parameters, then it uses AND logic.
KeyPossible values if fixed
subject*
name*
statusenabled, disabled
createdOn[from]Y-m-d
createdOn[to]Y-m-d
campaignId*
triggerTypeonday
fieldsstringList of fields that should be returned. Id is always returned. Fields should be separated by comma
sorthashEnable sorting using specified field (set as a key) and order (set as a value). You can specify multiple fields to sort by.
KeyPossible values if fixed
subjectasc,desc
nameasc,desc
createdOnasc,desc
perPageintNumber results on page
pageintPage number

Example Response

[
    {
        "autoresponderId": "p",
        "href": "http://api.getresponse.com/v3/autoresponders/p",
        "name": "Message 2",
        "subject": "test12",
        "status": "active",
        "fromField": {
            "fromFieldId": "V",
            "href": "http://api.getresponse.com/v3/fromField/V"
        },
        "replyTo": null,
        "createdOn": "2014-09-29T12:26:10+0000",
        "campaignId": "V",
        "content": {
            "plain": null,
            "html": null
        },
        "flags": [],
        "sendSettings": {
            "type": "delay",
            "delayInHours": "50400",
            "sendAtHour": null,
            "recurrence": "false",
            "timeTravel": "false",
            "excludedDaysOfWeek": [
                "Monday",
                "Tuesday",
                "Thursday",
                "Sunday"
            ]
        },
        "triggerSettings": {
            "type": "onday",
            "autoresponder": null,
            "newsletter": null,
            "clickTrackId": null,
            "goal": null,
            "custom": null,
            "action": null,
            "newCustomValue": null,
            "subscribeCampaign": null,
            "dayOfCycle": "13",
            "selectedCampaigns": [
                "o5lx"
            ],
            "selectedSegments": []
        }
    }
]

Returns status code

200

Request url

/autoresponders/V/thumbnail?size=small

Request params

Field nameField typeField description
sizestringSize of thumbnail, possible values: default,small