REST API

REST API

Legacy Poppulo platform REST API

Tag

Overview

Tags are lightweight ways of grouping subscribers. For example, one might want to send some content to subscribers who open lots of emails, or inversely those who open few emails. One way to do this is to use the Poppulo reporting to identify such subscribers, and then tag them as "Engaged" or "Unengaged". Once the appropriate content has been prepared, it can be sent to the subscribers identified by this tag.

Of particular note are "test" tags. These tags were used to identify groups of test subscribers. This functionality has been deprecated in favour of Reviewer Groups.

Fields

Field nameDescriptionType/Allowed values
nameThe tag's nameText
descriptionA description of the tagText
testIndicates if this tag identifies a tester group (deprecated)Boolean

Example

<tag name="All Testers" uri="https://api.newsweaver.com/v2/example-account/tag/All%20Testers">
    <description>Testers</description>
    <test>true</test>
    <link
        href="https://api.newsweaver.com/v2/example-account/subscribers?tags=All%20Testers"
        rel="http://api-info.newsweaver.com/v2/rels/tag.subscribers"
        title="Subscribers tagged with (All Testers)"/>
</tag>

See calls: