REST API

REST API

Legacy Poppulo platform REST API

Get Subscriber Import

Overview

NameDescription
HTTP MethodGET
URLhttps://api.newsweaver.com/v2/{account code}/subscriber_import/{subscriber import id}
Query ParametersN/A
Request representationN/A
Response representationSubscriber Import
Success Response Code200 Ok

Errors

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

Example: https://api.newsweaver.com/v2/example-account/subscriber_import/1166694

<subscriber_import created="2012-01-17T10:32:10Z" status="COMPLETED" uri="https://api.newsweaver.com/v2/example-account/subscriber_import/1166694">
    <specification>
        <accept_terms>false</accept_terms>
        <subscriber_data>
            <columns>email</columns>
            <skip_first_line>false</skip_first_line>
            <field_separator>comma</field_separator>
        </subscriber_data>
        <update_existing>true</update_existing>
        <reactivate_api_removed>false</reactivate_api_removed>
        <reactivate_admin_removed>false</reactivate_admin_removed>
        <reactivate_bounced_removed>false</reactivate_bounced_removed>
        <optout_reason>ADMIN</optout_reason>
        <tags>
            <tag name="Education Subscribers"/>
        </tags>
        <add_permissions>
            <permission name="Newsletter"/>
        </add_permissions>
    </specification>
    <results>
        <total_records>1</total_records>
        <new_subscribers>1</new_subscribers>
        <updated_subscribers>0</updated_subscribers>
        <invalid_records>0</invalid_records>
        <duplicates>0</duplicates>
        <previously_opted_out>0</previously_opted_out>
        <link
            href="https://api.newsweaver.com/v2/example-account/subscriber_import/1166694/invalid_subscribers"
            rel="http://api-info.newsweaver.com/v2/rels/subscriber_import.invalid_subscribers"
            title="Subscriber Import (1166694) Error Subscribers"/>
    </results>
</subscriber_import>