Take a page off the site, or unschedule it

POST

/api/v1/workspaces/{workspace}/pages/{page}/unpublish

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

• Your ReputeCast public URL

Permission: website:publish (sensitive)

Authorizations

• bearer

Parameters

Path Parameters

workspace

required

Workspace slug

string

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

Workspace slug

page

required

The page’s id

string format: uuid

The page’s id

Request Body^required

Media typeapplication/json

object

reason

string

<= 300 characters

redirectTo

string

<= 300 characters

Example ^generated

{
  "reason": "example",
  "redirectTo": "example"
}

Responses

200

OK

Media typeapplication/json

object

changes

required

boolean

checks

required

Array<object>

object

account

string

at

string format: date-time

by

string

count

integer format: int64

detail

string

httpStatus

integer format: int64

key

required

string

Allowed values: address heading moments product stripe form images links visibility store_blocks

mode

string

name

string

path

string

problem

string

pwyw

boolean

ref

string

status

required

string

Allowed values: pass warn block

counts

required

object

blocks

required

integer format: int64

images

required

integer format: int64

imagesWithAlt

required

integer format: int64

links

required

integer format: int64

createdAt

required

string format: date-time

draft

required

object

autosaved

required

boolean

html

required

string

project

required

savedAt

required

string format: date-time

savedBy

object

avatarColor

required

string

id

required

string

initials

required

string

name

required

string

version

required

integer format: int32

host

required

string

id

required

string

live

object

path

required

string

publishedAt

string format: date-time

publishedBy

object

avatarColor

required

string

id

required

string

initials

required

string

name

required

string

slug

required

string

url

required

string

version

required

integer format: int32

name

required

string

navFull

required

boolean

numbers

required

object

result

required

object

amountCents

required

integer format: int64

conversion

required

number format: double

count

required

integer format: int64

currency

required

string

kind

required

string

Allowed values: signups registrations sales none

views

required

integer format: int64

path

required

string

publish

required

object

approvers

required

Array<string>

canEdit

required

boolean

canManage

required

Navigation, visibility and the paywall (website:manage)

boolean

canPublish

required

boolean

needsApproval

required

boolean

pending

object

id

required

string

requestedAt

required

string format: date-time

requestedBy

required

string

publishers

required

Array<string>

reason

string

rule

string

publishAt

string format: date-time

publishTz

string

redirectTo

string

settings

required

object

hideHeader

required

Focused landing pages: the site header shows the logo only

boolean

navLabel

required

string

seoDescription

required

string

seoTitle

required

string

showInNav

required

boolean

socialImage

required

string

tiers

required

Paid pages: the tiers that may read it (empty: every paid tier)

Array<string>

visibility

required

string

Allowed values: public members paid

slug

required

string

status

required

string

Allowed values: draft scheduled published unpublished

template

required

string

Allowed values: about lead_magnet launch webinar sales blank

unpublishReason

string

unpublishedAt

string format: date-time

url

required

string

versions

required

integer format: int64

websiteOn

required

boolean

Example

{
  "checks": [
    {
      "key": "address",
      "status": "pass"
    }
  ],
  "numbers": {
    "result": {
      "kind": "signups"
    }
  },
  "settings": {
    "visibility": "public"
  },
  "status": "draft",
  "template": "about"
}

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