REST API

Legacy Poppulo platform REST API

Get Subscriber

Overview

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

Errors

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

Example: https://api.newsweaver.com/v2/example-account/subscriber/joe.bloggs@example.com

<subscriber date_modified="2012-01-17T10:32:11Z" uri="https://api.newsweaver.com/v2/example-account/subscriber/joe.bloggs@example.com">
    <link
        href="https://api.newsweaver.com/v2/example-account/subscriber/1dc0ag2floc"
        rel="edit"
        title="Edit: Subscriber (1dc0ag2floc)"/>
    <link
        href="https://api.newsweaver.com/v2/example-account/subscriber/1dc0ag2floc/tags"
        rel="http://api-info.newsweaver.com/v2/rels/subscriber.tags"
        title="Subscriber (1dc0ag2floc) Tags"/>
    <link
        href="https://api.newsweaver.com/v2/example-account/subscriber/1dc0ag2floc/topics"
        rel="http://api-info.newsweaver.com/v2/rels/subscriber.topics"
        title="Subscriber (1dc0ag2floc) Topics"/>
    <link
        href="https://api.newsweaver.com/v2/example-account/subscriber/1dc0ag2floc/sections"
        rel="http://api-info.newsweaver.com/v2/rels/subscriber.sections"
        title="Subscriber (1dc0ag2floc) Sections"/>
    <link
        href="https://api.newsweaver.com/v2/example-account/subscriber/1dc0ag2floc/permissions"
        rel="http://api-info.newsweaver.com/v2/rels/subscriber.permissions"
        title="Subscriber (1dc0ag2floc) Permissions"/>
    <link
        href="https://api.newsweaver.com/v2/example-account/subscriber/1dc0ag2floc/reviewer_groups"
        rel="http://api-info.newsweaver.com/v2/rels/subscriber.reviewer_groups"
        title="Subscriber (1dc0ag2floc) Reviewer Groups"/>
    <city>New York</city>
    <email>joe.bloggs@example.com</email>
    <status>ACTIVE</status>
    <source>Website</source>
    <surname>Bloggs</surname>
    <company>Acme, Inc.</company>
    <country>United States of America</country>
    <address1>123 Fake Street</address1>
    <address2>Fiction Road</address2>
    <address3>Nowhere</address3>
    <fax_number>555 12345 99</fax_number>
    <first_name>Joe</first_name>
    <salutation>Mr</salutation>
    <middle_name>R</middle_name>
    <mail_format>Html</mail_format>
    <postal_code>1234</postal_code>
    <phone_number>555 12345 88</phone_number>
    <county_state>New York</county_state>
    <date_created>2012-01-17T10:32:11Z</date_created>
    <position_company>Developer</position_company>
</subscriber>

Note:

For non-email records, you must use the subscriber ID to retrieve subscribers. Be sure to save this value on subscriber creation. Alternatively you can list all subscribers, as described on List subscribers

Overview

Errors

Note: