SparkLoop
  • API v2
    • Endpoints
      • Subscribers
        • Events
      • Referral Campaigns
        • Campaign Memberships
        • Subscribers
      • Partner Profile
        • Recommendations
        • Payouts
      • Publications
      • Upscribe
        • Recommendations
      • Partner Programs
      • Partner Network
        • Publications
        • Partner Programs
      • Webhooks
    • Schemas
      • Partner Profile Object
      • Partner Program Object
      • Publication Object
      • Subscriber Object
      • Campaign Object
      • Upscribe Object
      • Recommendation Object
    • Guides
      • How to use Upscribe via API
  • API v1
    • Campaigns
    • Subscribers
    • Events
    • Webhooks
  • Webhooks
  • Changelog
Powered by GitBook
On this page

Was this helpful?

  1. API v2
  2. Schemas

Publication Object

Example

{
  "publication": {
    "uuid": "pub_4bc1056297",
    "name": "My first newsletter",
    "publication_url": "https://sparkloop.app/newsletter",
    "description": "Publication for my first newsletter",
    "auto_pilot": true,
    "partner_categories": ["marketing", "tech"],
    "list_id": "c34kko0",
    "status": "active",
    "created_at": "2021-03-24T11:55:02.113Z",
    "logo_url": "https://example.com/path-to-logo.png"
  }
}
Property
Type
Description

uuid

string

Unique ID of the publication

name

string

Publication's name

publication_url

string

Publication's website

description

string

Publication's description

auto_pilot

boolean

Whether or not this publication has auto-pilot enabled.

partner_categories

array of strings

Publication's categories

status

string

The status of the publication (draft, active, archived)

logo_url

string

URL to the publication's logo

list_id

string

The list ID from your ESP (if your ESP supports lists)

created_at

timestamp

The date the publication was created

PreviousPartner Program ObjectNextSubscriber Object

Last updated 1 month ago

Was this helpful?