Render the upgrade page with unsaved settings

POST

/api/v1/workspaces/{workspace}/earn/upgrade-page/preview

curl --request POST \
  --url https://reputecast.example.com/api/v1/workspaces/acme-newsletter/earn/upgrade-page/preview \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "as": "visitor", "page": { "buttons": { "additionalProperty": "example" }, "defaultPeriod": "month", "faq": [ { "a": "example", "q": "example" } ], "freeLine": "example", "freeList": "example", "freeText": "example", "headline": "example", "highlight": "example", "highlightLabel": "example", "intro": "example", "off": [ "example" ], "order": [ "example" ], "welcome": "example" } }'

• Your ReputeCast public URL

Permission: earn:view

Nothing is saved; the page’s links and buttons don’t work in the preview.

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

as

required

string

default: visitor

Allowed values: visitor free paid offer

page

required

object

buttons

A tier’s button when it has no trial (“Become a founding member”), by tier id.

object

key

additional properties

string

defaultPeriod

required

string

Allowed values: month year

faq

required

Array<object>

<= 8 items

object

a

required

string

<= 800 characters

q

required

string

<= 160 characters

freeLine

required

string

<= 120 characters

freeList

required

string

<= 40 characters

freeText

required

string

<= 300 characters

headline

required

string

<= 120 characters

highlight

required

string

<= 40 characters

highlightLabel

required

string

<= 30 characters

intro

required

string

<= 600 characters

off

required

Array<string>

<= 20 items

order

required

Array<string>

<= 20 items

welcome

required

The welcome page after checkout; {{ first_name }} and {{ next_issue }} are filled in.

string

<= 400 characters

Responses

200

OK

Media typeapplication/json

object

html

required

string

Example ^generated

{
  "html": "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"
}