Draw the Feed items block and the subject with a preview's posts (the composer in digest mode)

POST

/api/v1/workspaces/{workspace}/digests/{digestId}/render

curl --request POST \
  --url https://reputecast.example.com/api/v1/workspaces/acme-newsletter/digests/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/render \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "block": { "buttonText": "example", "excerptWords": 1, "fallback": "example", "fallbackName": "example", "fields": [ "example" ], "layout": "list", "max": 1, "order": "newest", "overflow": "drop" }, "mjml": "example", "preheader": "example", "preview": "next", "sizes": true, "subject": "example" }'

• Your ReputeCast public URL

Permission: campaigns:view

Authorizations

• bearer

Parameters

Path Parameters

workspace

required

Workspace slug

string

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

Workspace slug

digestId

required

string format: uuid

Request Body^required

Media typeapplication/json

object

block

object

buttonText

required

string

<= 60 characters

excerptWords

required

integer format: int64

>= 5 <= 200

fallback

string

<= 500 characters

fallbackName

string

<= 200 characters

fields

required

Image, title (linked), date, author, categories, excerpt, button

Array<string>

<= 7 items

layout

required

string

Allowed values: list cards grid

max

required

integer format: int64

>= 1 <= 20

order

required

string

Allowed values: newest oldest

overflow

required

string

Allowed values: drop keep

mjml

string

<= 2000000 characters

preheader

string

<= 500 characters

preview

required

string

Allowed values: next last one six

sizes

boolean

subject

string

<= 998 characters

Responses

200

OK

Media typeapplication/json

object

checks

required

object

altFromTitle

required

integer format: int64

bytes

required

integer format: int64

fallback

required

integer format: int64

fitPosts

required

integer format: int64

images

required

integer format: int64

limit

required

integer format: int64

links

required

integer format: int64

maxBytes

required

integer format: int64

maxPosts

required

integer format: int64

count

required

integer format: int64

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

mjml

required

string

number

required

integer format: int64

preheader

required

string

preview

required

string

sendAt

string format: date-time

sizes

required

Array<object>

object

bytes

required

integer format: int64

posts

required

integer format: int64

starterSubject

required

string

subject

required

string

subjects

required

Array<object>

object

items

required

integer format: int64

text

required

string

zeroMore

required

boolean

tokens

required

Array<object>

object

token

required

string

value

required

string

Example

{
  "items": [
    {
      "leftOutBy": "category",
      "status": "new"
    }
  ]
}

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"
}