Preview newsletter channel

GET

/cms/channel/{channel_id}/preview

curl --request GET \
  --url https://api.example.com/cms/channel/1/preview \
  --header 'API-Key: <API-Key>'

• The API server for the WhiteBeard News Suite
• Local development server for the WhiteBeard News Suite
• Local worker for the WhiteBeard News Suite

Returns a preview of a newsletter or email channel

Authorizations

• ApiKeyAuth

Parameters

Path Parameters

channel_id

required

integer

Responses

200

Preview HTML and channel data

Media typeapplication/json

object

error

boolean

html

string

data

Channel

API representation of a channel

object

id

Channel ID

integer format: int64

name

Channel name

string

image

Channel image

string

description

Channel description

string

objectType

Object type

string

configuration

Channel configuration

object

Example ^generated

{
  "error": true,
  "html": "example",
  "data": {
    "id": 1,
    "name": "example",
    "image": "example",
    "description": "example",
    "objectType": "example",
    "configuration": {}
  }
}