REST API

REST API

Legacy Poppulo platform REST API

Publication

Overview

This is a Publication in our system. It is the basic unit of our system, a subscriber receives emails from one or more publications. Publications can contain a mix of content i.e. both Flyers and Newsletters. Flyers tend to be simple emails, whereas Newsletters contain articles and tend to be much more complex.

Fields

Field nameDescriptionType/Allowed values
codePublication code. Can be used to lookup publication. Forms part of our Microsite technology.Short Code
nameThe name of this publication.Text
category1Indicates whether a publication is a flyer or a newsletter.Enumeration of Newsletter, Flyer
descriptionA description of the purpose of the publicationText

Example

<publication code="newsletter" uri="https://api.newsweaver.com/v2/example-account/publication/63795">
    <link
        href="https://api.newsweaver.com/v2/example-account/publication/63795/issues"
        rel="http://api-info.newsweaver.com/v2/rels/publication.issues"
        title="Publication (63795) Issues"/>
    <link
        href="https://api.newsweaver.com/v2/example-account/publication/63795/sections"
        rel="http://api-info.newsweaver.com/v2/rels/publication.sections"
        title="Publication (63795) Sections"/>
    <name>Newsletter</name>
    <description>This is a Newsletter.</description>
</publication>

See calls:

Footnotes

  1. This functionality is deprecated and may not be available to you. ↩