Skip to content
ReputeCastReputeCast Docs

Create a recurring digest from a feed or a connected WordPress site

POST
/api/v1/workspaces/{workspace}/digests
curl --request POST \
  --url https://reputecast.example.com/api/v1/workspaces/acme-newsletter/digests \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "feedUrl": "example", "name": "example", "siteId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "source": "url" }'

Permission: campaigns:edit

The digest starts off, with the Blog digest template, the workspace’s default sender and its time zone. Without campaigns:send it starts in draft mode.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
workspace
required

Workspace slug

string
/^[a-z0-9][a-z0-9-]{1,62}$/

Workspace slug

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
object
feedUrl
string
<= 500 characters
name
string
<= 200 characters
siteId
string format: uuid
source
required
string
Allowed values: url wordpress

Responses

Section titled “Responses”

201

Section titled “201”

Created

Media typeapplication/json
object
approvals
required
object
approvers
required
Array<string>
needed
required
boolean
rules
required
Array<object>
object
key
required
string
label
required
string
short
required
string
threshold
integer format: int64
until
string format: date-time
archive
required
boolean
audience
required
object
base
required
integer format: int64
duplicates
required
integer format: int64
empty
required
boolean
final
required
integer format: int64
label
required
string
listIds
required
Array<string>
role
required
integer format: int64
segmentIds
required
Array<string>
stopped
required
integer format: int64
suppressed
required
integer format: int64
categoryOptions
required
Array<string>
createdAt
required
string format: date-time
createdBy
object
color
required
string
id
required
string
initials
required
string
name
required
string
editHelpers
required
Array<string>
feed
required
object
bytes
required
integer format: int64
error
object
detail
required
string
hops
required
Array<object>
object
location
string
status
required
integer format: int64
url
required
string
host
required
string
kind
required
string
lines
required
Array<string>
seconds
integer format: int64
status
integer format: int64
url
required
string
items
required
integer format: int64
kind
string
Allowed values: rss atom json ""
lastOkAt
string format: date-time
lastReadAt
string format: date-time
lastReadVia
string
leftOut
required
integer format: int64
movedTo
string
status
required
string
Allowed values: unread ok unreachable invalid
title
required
string
url
required
string
waiting
required
integer format: int64
feedUrl
required
string
filters
required
object
categories
required
Array<string>
maxAgeDays
integer format: int64
>= 1 <= 365
startLatest
required
integer format: int64
>= 1 <= 20
startMode
required
string
Allowed values: after_on latest
tags
required
Array<string>
firstOnAt
string format: date-time
firstSentAt
string format: date-time
id
required
string
lateHours
required
integer format: int64
mode
required
string
Allowed values: auto draft
name
required
string
next
object
approval
object
decidedAt
string format: date-time
decidedBy
object
color
required
string
id
required
string
initials
required
string
name
required
string
id
required
string
requestedAt
required
string format: date-time
rules
required
Array<string>
status
required
string
campaignId
string
deadline
string format: date-time
feedTries
required
Array<object>
object
at
required
string format: date-time
error
required
string
kind
required
string
fit
required
integer format: int64
heldAt
string format: date-time
holdReason
string
Allowed values: readiness changes rejected no_approvers ""
id
required
string
items
required
Array<object>
object
altFromTitle
required
boolean
author
required
string
categories
required
Array<string>
excerpt
required
string
fallback
required
boolean
firstSeenAt
required
string format: date-time
firstSeenVia
required
string
id
required
string
image
string
imageAlt
string
leftOutBy
string
Allowed values: category tag age ""
published
string format: date-time
sentIn
integer format: int64
status
required
string
Allowed values: new sent left_out before_start
tags
required
Array<string>
title
required
string
url
required
string
nextTry
string format: date-time
number
required
integer format: int64
posts
required
integer format: int64
preheader
required
string
prepareAt
string format: date-time
preparedAt
string format: date-time
readiness
object
blocking
required
Array<string>
blocks
required
integer format: int64
passed
required
integer format: int64
ranAt
required
string format: date-time
runId
required
string
verdict
required
string
warnings
required
integer format: int64
recipients
required
integer format: int64
sendAt
string format: date-time
status
required
string
Allowed values: collecting preparing prepared waiting held draft sending sent skipped not_sent
subject
required
string
subjects
required
Array<object>
object
items
required
integer format: int64
text
required
string
zeroMore
required
boolean
nextSend
string format: date-time
owner
object
color
required
string
id
required
string
initials
required
string
name
required
string
ownerSince
string format: date-time
pause
object
at
string format: date-time
by
string
from
string
left
boolean
note
string
notified
required
Array<string>
reason
required
string
Allowed values: person owner feed
skips
required
Array<object>
object
kind
required
string
sendAt
required
string format: date-time
to
string
pauseHelpers
required
Array<string>
prepareHours
required
integer format: int64
route
required
object
override
required
boolean
shares
required
Array<object>
object
adapter
required
string
name
required
string
percent
required
number format: double
providerId
required
string
short
required
string
status
required
string
warmupDay
integer format: int64
warmupDays
integer format: int64
warmupEnds
string format: date-time
schedule
required
object
count
integer format: int64
<= 50
frequency
required
string
Allowed values: daily weekly monthly items
monthDay
integer format: int64
<= 31
monthRule
string
Allowed values: day first ""
time
required
string
/^([01][0-9]|2[0-3]):[0-5][0-9]$/
timezone
required
string
<= 64 characters
weekday
required
integer format: int64
<= 6
weekdaysOnly
boolean
windowFrom
string
/^(([01][0-9]|2[0-3]):[0-5][0-9])?$/
windowUntil
string
/^(([01][0-9]|2[0-3]):[0-5][0-9])?$/
sendHelpers
required
Array<string>
sender
object
email
required
string
id
required
string
name
required
string
sentIssues
required
integer format: int64
site
object
connectedAt
required
string format: date-time
connectedBy
required
string
draftCategories
required
Array<string>
draftList
string
feedUrl
required
string
host
required
string
id
required
string
items
required
integer format: int64
lastReportAt
string format: date-time
latestPlugin
required
string
name
required
string
pluginVersion
required
string
status
required
string
Allowed values: ok silent outdated
source
required
string
Allowed values: url wordpress
state
required
string
Allowed values: off on paused
tagOptions
required
Array<string>
templateId
required
string
templateSavedAt
string format: date-time
templateVersion
required
integer format: int64
thresholds
required
object
bounce
required
number format: double
complaint
required
number format: double
custom
required
boolean
scope
required
string
Allowed values: route campaign
updatedAt
required
string format: date-time

Example 

{
  "feed": {
    "kind": "rss",
    "status": "unread"
  },
  "filters": {
    "startMode": "after_on"
  },
  "mode": "auto",
  "next": {
    "holdReason": "readiness",
    "items": [
      {
        "leftOutBy": "category",
        "status": "new"
      }
    ],
    "status": "collecting"
  },
  "pause": {
    "reason": "person"
  },
  "schedule": {
    "frequency": "daily",
    "monthRule": "day",
    "time": "08:00",
    "timezone": "America/New_York"
  },
  "site": {
    "status": "ok"
  },
  "source": "url",
  "state": "off",
  "thresholds": {
    "scope": "route"
  }
}

default

Section titled “default”

Error

Media typeapplication/problem+json
object
code

Stable error code, e.g. permission_denied

string
detail

A human-readable explanation specific to this occurrence of the problem.

string
errors

Optional list of individual error details

Array<object>
object
location

Where the error occurred, e.g. ‘body.items[3].tags’ or ‘path.thing-id’

string
message

Error message text

string
value

The value at the given location

helpers

Members who hold the missing permission

Array<string>
instance

A URI reference that identifies the specific occurrence of the problem.

string format: uri
meta
object
key
additional properties
permission

The missing permission key

string
status

HTTP status code

integer format: int64
title

A short, human-readable summary of the problem type. This value should not change between occurrences of the error.

string
type

A URI reference to human-readable documentation for the error.

string format: uri
default: about:blank

Example 

{
  "detail": "Property foo is required but is missing.",
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "about:blank"
}
Report a problem with this pageReputeCast websiteHostReputeContent licensed under CC BY 4.0