Returns status code

200

Request url

/rss-newsletters?query[subject]=test&fields=name,status&sort[createdOn]=asc&page=1&perPage=100

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*
statusenabled|disabled
createdOn[from]YYYY-mm-dd
createdOn[to]YYYY-mm-dd
campaignIdCampaigns id
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).
KeyPossible values if fixed
createdOnasc,desc
perPageintNumber results on page
pageintPage number

Example Response

[
    {
        "rssNewsletterId": "V",
        "href": "http://api.getresponse.com/v3/rss-ewsletters/V",
        "rssFeedUrl": "http://blog.getresponse.com",
        "name": "rsstest0",
        "createdOn": "2014-09-29T12:25:52+0000",
        "subject": "My rss to newsletters",
        "flags": "openrate",
        "status": "enabled",
        "fromField": {
            "fromFieldId": "V",
            "href": "http://api.getresponse.com/v3/from-fields/V"
        },
        "replyTo": {
            "fromFieldId": "M",
            "href": "http://api.getresponse.com/v3/from-fields/M"
        },
        "content": {
            "html": "",
            "plain": ""
        },
        "sendSettings": {
            "frequency": "asap",
            "sendAtHour": null,
            "sendAtWeekDay": null,
            "sendAtMonthDay": null,
            "filter": "recent",
            "maxArticles": "30",
            "selectedCampaigns": [
                "V"
            ],
            "selectedSegments": [],
            "selectedSuppresions": [],
            "excludedCampaigns": [],
            "excludedSegments": []
        },
        "clickTracks": null
    }
]

Returns status code

200

Example Request Body

{
    "rssFeedUrl": "http://blog.getresponse.com",
    "name": "rsstest0",
    "subject": "My rss to newsletter",
    "flags": [
        "openrate"
    ],
    "status": "enabled",
    "fromField": {
        "fromFieldId": "V"
    },
    "replyTo": {
        "fromFieldId": "M"
    },
    "content": {
        "html": "test of html content",
        "plain": "other content"
    },
    "sendSettings": {
        "frequency": "asap",
        "sendAtHour": null,
        "sendAtWeekDay": null,
        "sendAtMonthDay": null,
        "filter": "recent",
        "maxArticles": "30",
        "selectedCampaigns": [
            "V"
        ],
        "selectedSegments": [],
        "selectedSuppresions": [],
        "excludedCampaigns": [],
        "excludedSegments": []
    }
}

Body params

Field nameField typeField description
rssFeedUrl (required)stringUrl with RSS Feed
namestringHow your newsletters will be seen in panel (length: 1-255)
subject (required)stringMessage subject (length: 1-255)
flagssetMessage flags. Allowed values: openrate, clicktrack and google_analytics
status (required)stringMessage status enabled|disabled
editorstringHow message was created: 'custom' - custom made message,'plain' - plain content,'getresponse' - via gr editor]
fromfield (required)objectMessage from email
Field nameField typeField description
fromFieldId (required)stringFrom-fields resource id
fromfieldobjectReply to email
Field nameField typeField description
fromFieldId (required)stringFrom-fields resource id
content (required)collectionMessage contents
Field nameField typeField description
htmlstringHTML content of message (max. length 524288)
plainstringPlain text content equivalent of message (max. length 524288)
sendSettingscollectionHow message will be delivered to subscriber
Field nameField typeField description
frequency (required)stringWhen to send email: asap, daily, weekly, monthly
sendAtHourintegerOn which hour email should be sent. Possible values: 0-23. Required if frequency: daily, weekly or monthly
sendAtWeekDayintegerOn which day of week email should be sent (required for frequency weekly). Possible values: Monday, Tuesday, Wednesday, Thursday, Friday, Saturday, Sunday
sendAtMonthDayintegerOn which day of month email should be sent (required for frequency monthly). Possible values: Values from 1-28
filter (required)stringRSS posts filter settings: recent, engaged, shared, commented
maxArticlesstringHow many articles to display on lists: default 10, range: 1-30
selectedCampaigns (required)setList of campaigns id to choose subscribers
selectedSegments (required)setList of segments id to choose subscribers
selectedSuppressions (required)setList of suppressions id to exclude subscribers
excludedCampaigns (required)setList of campaigns id to exclude subscribers
excludedCampaigns (required)setList of campaigns id to exclude subscribers

Example Response

{
    "rssNewsletterId": "V",
    "href": "http://api.getresponse.com/v3/rss-newsletters/V",
    "rssFeedUrl": "http://blog.getresponse.com",
    "name": "rsstest0",
    "createdOn": "2014-09-29T12:25:52+0000",
    "subject": "My rss to newsletter",
    "flags": "openrate",
    "status": "enabled",
    "fromField": {
        "fromFieldId": "V",
        "href": "http://api.getresponse.com/v3/from-fields/V"
    },
    "replyTo": {
        "fromFieldId": "M",
        "href": "http://api.getresponse.com/v3/from-fields/M"
    },
    "content": {
        "html": "test0",
        "plain": null
    },
    "sendSettings": {
        "frequency": "asap",
        "sendAt": null,
        "filter": "recent",
        "maxArticles": "30",
        "selectedCampaigns": [
            "V"
        ],
        "selectedSegments": [],
        "selectedSuppresions": [],
        "excludedCampaigns": [],
        "excludedSegments": []
    },
    "clickTracks": []
}

Possible Errors


Returns status code

200

Example Response

{
    "rssNewsletterId": "V",
    "href": "http://api.getresponse.com/v3/rss-newsletters/V",
    "rssFeedUrl": "http://blog.getresponse.com",
    "name": "rsstest0",
    "createdOn": "2014-09-29T12:25:52+0000",
    "subject": "My rss to newsletter",
    "flags": "openrate",
    "status": "enabled",
    "fromField": {
        "fromFieldId": "V",
        "href": "http://api.getresponse.com/v3/from-fields/V"
    },
    "replyTo": {
        "fromFieldId": "M",
        "href": "http://api.getresponse.com/v3/from-fields/M"
    },
    "content": {
        "html": "test0",
        "plain": null
    },
    "sendSettings": {
        "frequency": "asap",
        "sendAtHour": null,
        "sendAtWeekDay": null,
        "sendAtMonthDay": null,
        "filter": "recent",
        "maxArticles": "30",
        "selectedCampaigns": [
            "V"
        ],
        "selectedSegments": [],
        "selectedSuppresions": [],
        "excludedCampaigns": [],
        "excludedSegments": []
    },
    "clickTracks": []
}

Returns status code

204

Returns status code

200

Example Request Body

{
    "rssFeedUrl": "http://blog.getresponse.com",
    "name": "rsstest0",
    "subject": "My rss to newsletter",
    "flags": "openrate",
    "status": "enabled",
    "fromField": {
        "fromFieldId": "V"
    },
    "replyTo": {
        "fromFieldId": "M"
    },
    "content": {
        "html": "test of html content",
        "plain": "other content"
    },
    "sendSettings": {
        "frequency": "asap",
        "sendAtHour": null,
        "sendAtWeekDay": null,
        "sendAtMonthDay": null,
        "filter": "recent",
        "maxArticles": "30",
        "selectedCampaigns": [
            "V"
        ],
        "selectedSegments": [],
        "selectedSuppresions": [],
        "excludedCampaigns": [],
        "excludedSegments": []
    }
}

Body params

Field nameField typeField description
rssFeedUrl (required)stringUrl with RSS Feed
namestringHow your newsletters will be seen in panel, (length: 1-255)
subject (required)stringMessage subject, (length: 1-255)
flagssetMessage flags. Allowed values: openrate, clicktrack and google_analytics
status (required)stringMessage status enabled|disabled
editorstringHow message was created: 'custom' - custom made message,'plain' - plain content,'getresponse' - via gr editor]
fromfield (required)objectMessage from email
Field nameField typeField description
fromFieldId (required)stringFrom-fields resource id
fromfieldobjectReply to email
Field nameField typeField description
fromFieldId (required)stringFrom-fields resource id
content (required)collectionMessage contents
Field nameField typeField description
htmlstringHTML content of message, (max. length 524288)
plainstringPlain text content equivalent of message, (max. length 524288)
sendSettingscollectionHow message will be delivered to subscriber
Field nameField typeField description
frequency (required)stringWhen to send email: asap, daily, weekly, monthly
sendAtHourintegerOn which hour email should be sent. Possible values: 0-23
sendAtWeekDayintegerOn which day of week email should be sent (required for frequency weekly). Possible values: Monday, Tuesday, Wednesday, Thursday, Friday, Saturday, Sunday
sendAtMonthDayintegerOn which day of month email should be sent (required for frequency monthly). Possible values: Values from 1-28
filter (required)stringRSS posts filter settings: recent, engaged, shared, commented
maxArticlesstringHow many articles to display on lists: default 10, range: 1-30
selectedCampaigns (required)setList of campaigns id to choose subscribers
selectedSegments (required)setList of segments id to choose subscribers
selectedSuppressions (required)setList of suppressions id to exclude subscribers
excludedCampaigns (required)setList of campaigns id to exclude subscribers
excludedCampaigns (required)setList of campaigns id to exclude subscribers

Example Response

{
    "rssNewsletterId": "V",
    "href": "http://api.getresponse.com/v3/rss-newsletters/V",
    "rssFeedUrl": "http://blog.getresponse.com",
    "name": "rsstest0",
    "createdOn": "2014-09-29T12:25:52+0000",
    "subject": "My rss to newsletter",
    "flags": "openrate",
    "status": "enabled",
    "fromField": {
        "fromFieldId": "V",
        "href": "http://api.getresponse.com/v3/from-fields/V"
    },
    "replyTo": {
        "fromFieldId": "M",
        "href": "http://api.getresponse.com/v3/from-fields/M"
    },
    "content": {
        "html": "test0",
        "plain": null
    },
    "sendSettings": {
        "frequency": "asap",
        "sendAt": null,
        "filter": "recent",
        "maxArticles": "30",
        "selectedCampaigns": [
            "V"
        ],
        "selectedSegments": [],
        "selectedSuppresions": [],
        "excludedCampaigns": [],
        "excludedSegments": []
    },
    "clickTracks": []
}

Returns status code

200

Request url

rss-newsletters/statistics?query[rssNewsletterId]=1,2?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. At least one of following is required: campaignId, rssNewsletterId
KeyPossible values if fixed
groupBytotal,hour,day,month
rssNewsletterIdList of newsletter 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"
    }
]

Returns status code

200

Request url

/rss-newsletters/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"
    }
]