Get Mailing

Name Description
HTTP Method GET
URL https://api.newsweaver.com/v2/{account code}/mailing/{mailing id}
Query Parameters N/A
Request representation N/A
Response representation Mailing
Success Response Code 200 Ok

Errors

  • 403 - Forbidden if API user doesn't have READ access to SEND
  • 404 - Not Found if the specified mailing doesn't exist
  • Common errors (user/account authentication errors, API usage limit errors)

Example: https://api.newsweaver.com/v2/example-account/mailing/1234

<mailing status="Completed" type="test" uri="https://api.newsweaver.com/v2/example-account/mailing/1234">
    <progress>
        <total_emails>1</total_emails>
        <emails_dispatched>1</emails_dispatched>
    </progress>
    <specification>
        <send_datetime>2011-06-01T10:34:14Z</send_datetime>
        <subject>Hello, world</subject>
        <from_name>Joe Bloggs</from_name>
        <from_address>joe.bloggs@example.com</from_address>
        <format>SUBSCRIBER_PREFERENCE</format>
        <to>
            <target_type>testers</target_type>
            <targets>
                <target>Main Reviewers</target>
            </targets>
        </to>
        <respect_quota>true</respect_quota>
        <resend_if_received>false</resend_if_received>
    </specification>
    <link
        href="https://api.newsweaver.com/v2/example-account/issue/123"
        rel="http://api-info.newsweaver.com/v2/rels/mailing.issue"
        title="Issue (123)"/>
    <link
        href="https://api.newsweaver.com/v2/example-account/mailing/1234/activity_summary"
        rel="http://api-info.newsweaver.com/v2/rels/mailing.activity_summary"
        title="Mailing (1234) Activity Summary"/>
    <link
        href="https://api.newsweaver.com/v2/example-account/mailing/1234/content_popularity"
        rel="http://api-info.newsweaver.com/v2/rels/mailing.content_popularity"
        title="Mailing (1234) Content Popularity"/>
</mailing>

results matching ""

    No results matching ""