REST API

Legacy Poppulo platform REST API

Account

Overview

This is a Account in our system. Accounts are shared data between users. Every object in our system is associated with an account. As the "entry point" into our API, viewing an account gives little useful data, but a very handy list of links you can follow to browse all areas of your account. From the API developers perspective, the account code is a key part of our API. It is included as part of all other URLs.

Fields

Field name	Description	Type/Allowed values
code	Account code. Can be used to lookup account. Used in general as part of the URL for all other calls. Forms part of our Microsite technology.	Short Code
name	Account name.	Text

Example

<account code="example-account" uri="https://api.newsweaver.com/v2/example-account">
    <link href="https://api.newsweaver.com/v2/example-account/tags" rel="http://api-info.newsweaver.com/v2/rels/account.tag" title="Tags"/>
    <link href="https://api.newsweaver.com/v2/example-account/topics" rel="http://api-info.newsweaver.com/v2/rels/account.topic" title="Topics"/>
    <link href="https://api.newsweaver.com/v2/example-account/mailings" rel="http://api-info.newsweaver.com/v2/rels/account.mailing" title="Mailings"/>
    <link href="https://api.newsweaver.com/v2/example-account/permissions" rel="http://api-info.newsweaver.com/v2/rels/account.permission" title="Permissions"/>
    <link href="https://api.newsweaver.com/v2/example-account/subscribers" rel="http://api-info.newsweaver.com/v2/rels/account.subscriber" title="Subscribers"/>
    <link href="https://api.newsweaver.com/v2/example-account/publications" rel="http://api-info.newsweaver.com/v2/rels/account.publication" title="Publications"/>
    <link href="https://api.newsweaver.com/v2/example-account/activity_sync" rel="http://api-info.newsweaver.com/v2/rels/account.activity_sync" title="Activity Sync"/>
    <link href="https://api.newsweaver.com/v2/example-account/reviewer_groups" rel="http://api-info.newsweaver.com/v2/rels/account.reviewer_group" title="Reviewer_groups"/>
    <link href="https://api.newsweaver.com/v2/example-account/subscriber_imports" rel="http://api-info.newsweaver.com/v2/rels/account.subscriber_import" title="Subscriber_imports"/>
    <name>Example Account</name>
</account>

Notes:

The set of links presented depend on the permissions you have.

See calls:

Overview

Fields

Example