Preview the home page with unsaved Home & navigation settings, as a visitor sees it

POST

/api/v1/workspaces/{workspace}/website/home-nav/preview

curl --request POST \
  --url https://reputecast.example.com/api/v1/workspaces/acme-newsletter/website/home-nav/preview \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "about": { "link": "example", "text": "example", "title": "example" }, "featured": [ "example" ], "footer": { "archive": true, "preferences": true, "rss": true }, "header": [ { "kind": "home", "label": "example", "ref": "example", "url": "example" } ], "identity": { "description": "example", "socialImage": "example", "tagline": "example", "title": "example" }, "index": true, "layout": "featured", "poweredBy": true, "privacyUrl": "example", "sections": [ { "count": 1, "kind": "subscribe", "note": "example", "on": true, "tag": "example", "text": "example" } ] }'

• Your ReputeCast public URL

Permission: website:view

Authorizations

• bearer

Parameters

Path Parameters

workspace

required

Workspace slug

string

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

Workspace slug

Request Body^required

Media typeapplication/json

object

about

required

object

link

required

string

<= 500 characters

text

required

string

<= 1200 characters

title

required

string

<= 80 characters

featured

required

Array<string>

<= 3 items

footer

required

object

archive

required

boolean

preferences

required

boolean

rss

required

boolean

header

required

Array<object>

<= 12 items

object

kind

required

string

Allowed values: home tag page archive url

label

string

<= 40 characters

ref

string

<= 120 characters

url

string

<= 500 characters

identity

required

object

description

required

string

<= 300 characters

socialImage

required

string

<= 1000 characters

tagline

required

string

<= 160 characters

title

required

string

<= 80 characters

index

required

boolean

layout

required

string

Allowed values: featured list grid

poweredBy

required

boolean

privacyUrl

required

string

<= 500 characters

sections

required

Array<object>

<= 30 items

object

count

integer format: int64

<= 24

kind

required

string

Allowed values: subscribe featured latest tag about tiers

note

string

<= 200 characters

on

required

boolean

tag

string

text

string

<= 300 characters

Responses

200

OK

Media typeapplication/json

object

contact

required

string

html

required

string

url

required

string

Example ^generated

{
  "contact": "example",
  "html": "example",
  "url": "example"
}

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