Skip to content
WhiteBeard
Search
Ctrl
K
Cancel
WhiteBeard Website
API
Select theme
Dark
Light
Auto
Publisher
Create and publish content
Using the AI Assistant
Comments Moderation
Create and send e-mails
Working with E-mail Templates
Working with Feeds
Multi-Factor Authentication (MFA)
Creating Social Posts
Using the Voice Editor
Revenue
Customer Account Deletion
Global Suppressions List
Importing Customer records
Paywall Customization
Automations
Setting Up Subscriptions
Subscription Status Codes
Analytics
Overview
Content Analytics
Email Analytics
Data Export
Setup
Overview
Analytics Setup (Matomo)
Analytics Setup (OpenPanel)
Print
Print Setup
Admin Guides
Feed Sources
Social Channels
Authentication Providers
Caching and cache purging
Cleaning Up Lists
Content Types
Content URL Structure
Content Statuses
Impersonating Customer Accounts
Content Components
Live Blogs
Messaging Tool Frontend Implementation
Page preview
Content preview
Self-Service Password Reset
SEO Sitemaps
Email Auto Login
Podcasts Setup
Users, Roles, and Permissions
API
Getting Started
Introduction
API Key
Customer Authentication
Rate Limiting
API Playground
Reference
Overview
Analytics (Search)
Overview
Get the on-site search report
GET
Get Google Web search keyword performance trend
GET
List Google Web search keyword performance
GET
List Google News search keyword performance
GET
List Google Image search keyword performance
GET
Analytics (Customer Insights)
Overview
Get the customer insights report
GET
Get active subscribers grouped by payment method
GET
Get active subscribers grouped by subscription group
GET
Get active subscribers grouped by product
GET
Get active subscribers grouped by country
GET
Get lost subscriptions grouped by cancellation reason
GET
Get lost subscriptions grouped by cancellation reason, excluding upgrades
GET
Get a forecast of upcoming lost subscriptions
GET
Analytics (Orders)
Overview
Get the orders report
GET
Get a combined new/renewal/lost/upgraded order-type summary
GET
Get revenue grouped by new vs. renewal
GET
Get order count grouped by subscription group
GET
Get revenue grouped by subscription group
GET
Get order count grouped by payment method
GET
Get revenue grouped by payment method
GET
Get order count grouped by product
GET
Get revenue grouped by product
GET
Get order count grouped by country
GET
Get revenue grouped by country
GET
Get order count grouped by acquisition source
GET
Get order count grouped by acquisition source button
GET
Get failed order count grouped by payment method
GET
Get failed order count grouped by payment gateway response message
GET
Get failed order count grouped by country
GET
Analytics (Paywall)
Overview
Get the paywall report
GET
Get paywall views over time
GET
Get paywall clicks over time
GET
Get paywall click-through rate over time
GET
Get datawall views over time
GET
Get datawall clicks over time
GET
Get datawall click-through rate over time
GET
Get datawall logins over time
GET
Get datawall account signups over time
GET
Get a breakdown of all paywall/datawall event names
GET
Analytics (Content Performance)
Overview
List content performance report
GET
Schedule a content performance export
POST
Analytics (Video Performance)
Overview
Get the video performance report
GET
Get performance detail for a single video
GET
Analytics (Audio Performance)
Overview
Get the audio performance report
GET
Get performance detail for a single audio file
GET
Analytics (Content Production)
Overview
Get the content production report
GET
Analytics (Assistant)
Overview
Get the AI assistant usage report
GET
Analytics (Social)
Overview
List the social channels overview report
GET
Get performance detail for a single social channel
GET
Analytics (Automations)
Overview
Get the automations report
GET
Analytics (Customers)
Overview
List the customer activity leaderboard report
GET
Analytics (Email)
Overview
Get the email/newsletter channel analytics report
GET
Get channel retention for the email/newsletter report
GET
Get customer account age for the email/newsletter report
GET
Get customer subscription status for the email/newsletter report
GET
Get customer acquisition source for the email/newsletter report
GET
Get recent customer acquisition source for the email/newsletter report
GET
Get newsletter visits by region for the email/newsletter report
GET
Get newsletter list acquisition source over time
GET
Analytics (Messaging)
Overview
List the in-app messaging campaigns report
GET
Get performance detail for a single message
GET
Authentication
Overview
OAuth2 Token Endpoint
POST
OAuth2 Authorization Endpoint
GET
Request login OTP
POST
Register a new customer
POST
Logout customer
POST
Author
Overview
List authors
GET
Get author by ID or by slug
GET
Get author's content by publication and page
GET
Category
Overview
List categories
GET
Get a single category
GET
Get content (articles) for a category
GET
Get content (articles) for a category, personalized for the authenticated visitor
GET
Podcast RSS feed for a category
GET
Channel
Overview
List channels
GET
Get channel
GET
Subscribe to multiple newsletter or push channels
POST
Subscribe to a newsletter or push channel
POST
Preview newsletter channel
GET
List newsletter posts
GET
Preview newsletter post
GET
Activate newsletter subscription
POST
Unsubscribe from multiple newsletter or push channels
POST
Unsubscribe from newsletter or push channel
POST
Content
Overview
Get content by ID or slug
GET
Preview content by version and key
GET
List comments for a content item
GET
Add a comment to an article
POST
Check whether the current authenticated customer has pending comments on a content item
GET
Rate an article from 1 to 5 based on customer choice
POST
Edit a user comment
POST
Delete a user comment
DELETE
Report a comment for moderation. The reasons list is configurable by the publisher; see GET /cms/comment/report/reasons for the current list. The default reasons are spam, harassment, hate_speech, misinformation, inappropriate_content, off_topic, terms_violation and other.
POST
List available comment report reasons
GET
Like a comment
POST
Unlike a comment
POST
Get likes count for a comment and whether the current user has liked it
GET
Get the comment IDs the current user has liked on a content item
GET
Search content
POST
Vector search content
POST
Suggest search terms
POST
List pending comments (admin)
GET
Add or update an article
POST
Like an article
POST
Unlike an article
POST
Get likes count for an article and whether the current user has liked it
GET
Undelete a deleted article
POST
Country
Overview
List countries
GET
Get country
GET
Customer
Overview
Get current customer profile
GET
Get customer profile
GET
Update customer profile
POST
Delete customer account
DELETE
Set customer username
POST
Get customer preference
GET
Update customer preferences
POST
Get customer preference
GET
Update customer preferences
POST
Remove customer preference
DELETE
Check if customer exists
POST
Send forgot password email
POST
Reset customer password
POST
Activate customer account
POST
Resend activation email
POST
Get customer payment token details
GET
Add value to customer preference key
POST
Delete value from customer preference key
POST
Upload profile image
POST
Check if activation code exists
POST
Get customer wishlist
GET
Add item to wishlist
POST
Remove item from wishlist
POST
Use purchased content
POST
Get content usage records
GET
Check if content has been used
GET
Remove content usage record
POST
Check if content is eligible for use
POST
List all available tags
GET
List available customer segments
GET
Assign a tag to a customer
POST
Remove a tag from a customer
DELETE
Assign a tag to a batch of customers
POST
Remove a tag from a batch of customers
DELETE
List customer comments
GET
Delete a saved payment card
DELETE
Get number of articles read by logged-in user (current year)
GET
Customer (Admin)
Overview
Get list of contents based on filters and columns
GET
Export content
POST
Get list of customers based on filters and columns
GET
List customer subscriptions
GET
Get customer subscription details
GET
Update the payment method of a customer subscription
POST
Set customer payment token details
POST
List customer payments
GET
Get payment details
GET
Get list of payments based on filters and columns
GET
Export payments
POST
Export customers
POST
Get list of subscriptions based on filters and columns
GET
Export subscriptions
POST
Feed
Overview
Get the followed items of the authenticated user
GET
Replace the entire feed of the authenticated user
PUT
Add or remove items from the authenticated user's feed
PATCH
Get content (articles) for a followed feed of a customer
GET
Form
Overview
List available forms
GET
Get form details
GET
Submit a form
POST
Job
Overview
Get job details
GET
Keyword
Overview
List keywords
GET
Get a keyword by ID or slug
GET
List content for a keyword within a publication
GET
List promoted keywords
GET
Media
Overview
Upload a media file
POST
Page Builder
Overview
List page builder blocks
GET
Get a page with its layout
GET
Get a resolved layout
GET
Get a resolved layout by key
GET
Preview an unpublished layout
GET
Page Builder Variants
Overview
Export registered variants
GET
Register variants from a manifest
PUT
Register one variant
PUT
Upload a variant's preview image
POST
Page
Overview
Get a page with its layout
GET
List pages
GET
Get page details
GET
List issues for a page
GET
View issue
GET
Download issue PDF
GET
Preview issue
GET
Paywall
Overview
Initialize paywall or record access
POST
Photos
Overview
List available photos
GET
Start chunked photo upload
POST
Get photo details
GET
Get current chunked upload offset
HEAD
Upload a photo chunk
PATCH
Attach or use a photo in content
POST
Poll
Overview
Get a poll by ID
GET
Vote on a poll
POST
List polls
GET
Validate a poll vote
POST
Product
Overview
List product categories
GET
Get product by ID
GET
Get pricing tier (product item) by ID
GET
Search products
POST
List all brands
GET
List brands in a category
GET
List products in a category
GET
List bestsellers in a category
GET
List approved reviews of a product
GET
Submit a review
POST
Get the current customer's review of a product
GET
Edit the current customer's review
PUT
Delete the current customer's review
DELETE
Publication
Overview
Get publication details
GET
List content for a publication
GET
News sitemap for publication (XML)
GET
Sitemap index for publication (XML)
GET
Article sitemap page (XML)
GET
Articles published on a given day (archive)
GET
Categories sitemap (XML)
GET
Authors sitemap (XML)
GET
Most read articles
GET
Most read articles
GET
Most shared articles
GET
Most commented articles
GET
Analytics (Daily Traffic)
Overview
Get the daily traffic report
GET
Get average connected users per hour of day
GET
Get visit share by country
GET
Get visits by country over time
GET
Get visits by device type over time
GET
Get visit share by referrer type
GET
Get visits by referrer type over time
GET
Get visits by campaign medium over time
GET
Get visits by campaign source over time
GET
Get visit share by device type
GET
Get new account creations over time
GET
Get hits broken down by publication
GET
Get hits broken down by content type
GET
Get hits broken down by category
GET
Get visit share by subscriber status
GET
Get top on-site search keywords
GET
Get comment counts over time
GET
Get most-read content aggregated by keyword
GET
Authentication - Deprecated
Overview
Login with credentials
POST
Login with token
POST
Login with Facebook
POST
Login with Google
POST
Login with Apple
POST
Login by IP address
POST
Get IP authentication tables
POST
Subscription
Overview
List customer subscriptions
GET
Get customer subscription details
GET
Unsubscribe from a subscription
POST
Immediately renew a subscription
POST
Start a new checkout session for renewing a subscription.
POST
Payment
Overview
List customer payments
GET
Get payment details
GET
List customer purchases
GET
Create a checkout session for the current customer
POST
Charge a customer using an existing token
POST
Create a subscription for the current customer
POST
Restore a purchase for the current customer from a payment provider receipt
POST
Start a token acquisition session (usually similar to a checkout session)
POST
Start a setup intent to acquire payment details on-site
POST
Get available payment methods
GET
Cart
Overview
Generate a new cart
POST
Add item to cart
POST
Set item quantity in cart
POST
Get cart items count
GET
Get cart details
GET
Check coupon code validity
GET
Add coupon to cart
POST
Mark coupon as used
POST
Remove coupon from cart
DELETE
Releases
Release History
Product roadmap
WhiteBeard Website
API
Select theme
Dark
Light
Auto
Overview
Page Builder Variants
Section titled “Page Builder Variants”
Register the display variants a frontend implements