REST API

REST API

Legacy Poppulo platform REST API

List Issue Mailings

Overview

NameDescription
HTTP MethodGET
URLhttps://api.newsweaver.com/v2/{account code}/issue/{issue id}/mailings
Query ParametersN/A
Request representationN/A
Response representationMailing List
Success Response Code200 Ok

Errors

  • 403 - Forbidden if API user doesn't have READ access to ISSUES and SEND
  • 404 - Not Found if issue does not exist
  • Common errors (user/account authentication errors, API usage limit errors)

Example

GET https://api.newsweaver.com/v2/example-account/issue/123/mailings

<mailings total="2" uri="https://api.newsweaver.com/v2/example-account/issue/123/mailings">
    <itemsPerPage>
        1000
    </itemsPerPage>
    <startIndex>
        0
    </startIndex>
    <totalResults>
        2
    </totalResults>
    <mailing status="Completed" type="subscriber" uri="https://api.newsweaver.com/v2/example-account/mailing/1">
            <specification>
                    <send_datetime>
                        2013-05-15T12:00:27Z
                    </send_datetime>
                    <subject>
                        TEST EMAIL - Hello, world
                    </subject>
            </specification>
    </mailing>
    <mailing status="Completed" type="subscriber" uri="https://api.newsweaver.com/v2/example-account/mailing/2">
            <specification>
                    <send_datetime>
                        2013-05-16T17:32:20Z
                    </send_datetime>
                    <subject>
                        Hello, world
                    </subject>
            </specification>
    </mailing>
</mailings>