Skip to content
ReputeCastReputeCast Docs

Review & send: the push checks, schedule and approvals

GET
/api/v1/workspaces/{workspace}/push-campaigns/{campaignId}/review
curl --request GET \
  --url https://reputecast.example.com/api/v1/workspaces/acme-newsletter/push-campaigns/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/review \
  --header 'Authorization: Bearer <token>'

Permission: campaigns:view

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

campaignId
required

Campaign id

string format: uuid

Campaign id

Responses

Section titled “Responses”

200

Section titled “200”

OK

Media typeapplication/json
object
access
required
object
canEdit
required
boolean
canSend
required
boolean
helpers
required
Array<string>
missing
required
Array<string>
approval
required
object
approvers
required
Array<object>
object
color
required
string
email
required
string
id
required
string
initials
required
string
name
required
string
presence
string
role
required
string
canBypass
required
boolean
canRequest
required
boolean
medianWaitMinutes
integer format: int64
needed
required
integer format: int64
policyRules
required
Array<string>
request
object
audit
object
action
required
string
actor
required
string
at
required
string format: date-time
ip
string
bypassReason
string
changes
required
Array<object>
object
after
required
string
before
required
string
field
required
string
Allowed values: subject preheader link content sender audience audience_count route schedule language
label
required
string
what
string
comment
string
decidedAt
string format: date-time
decidedBy
string
decisions
required
Array<object>
object
approver
required
object
color
required
string
email
required
string
id
required
string
initials
required
string
name
required
string
presence
string
role
required
string
at
required
string format: date-time
comment
required
string
decision
required
string
Allowed values: approve request_changes reject
followsId
string
given
required
integer format: int64
id
required
string
invalidatedAt
string format: date-time
invalidatedBy
string
invalidatedFields
string
invalidatedReason
string
needed
required
integer format: int64
note
required
string
requestedAt
required
string format: date-time
requestedBy
required
object
color
required
string
email
required
string
id
required
string
initials
required
string
name
required
string
presence
string
role
required
string
rules
required
Array<object>
object
author
string
badge
required
string
key
required
string
Allowed values: audience_min warming_provider new_provider ready_with_warnings author_lacks_send approval_lists automation_publish transactional_publish post_publish channel_cost_min client_signoff
label
required
string
role
string
short
required
string
snapshot
required
object
audienceCount
required
integer format: int64
routeLabel
required
string
routeText
required
string
scheduleAt
string format: date-time
scheduleMode
required
string
Allowed values: now at best_time
scheduleText
required
string
splitLabel
required
string
subject
required
string
timezone
string
version
required
integer format: int64
status
required
string
Allowed values: pending approved changes_requested rejected invalidated bypassed sent cancelled
subjectType
required
string
Allowed values: campaign automation transactional_template website_post website_page
version
required
integer format: int64
requestReason
string
required
required
boolean
rules
required
Array<object>
object
author
string
badge
required
string
key
required
string
Allowed values: audience_min warming_provider new_provider ready_with_warnings author_lacks_send approval_lists automation_publish transactional_publish post_publish channel_cost_min client_signoff
label
required
string
role
string
short
required
string
valid
required
boolean
audience
required
object
anonymous
required
integer format: int64
final
required
integer format: int64
linked
required
integer format: int64
narrowed
required
boolean
overCap
required
integer format: int64
total
required
integer format: int64
checkedAt
required
string format: date-time
checks
required
Array<object>
object
anonymous
required
integer format: int64
at
required
string format: date-time
atZone
required
string
author
string
authorRole
string
cap
required
integer format: int64
count
required
integer format: int64
cuts
required
Array<object>
object
lines
required
integer format: int64
platform
required
string
Allowed values: chrome_windows chrome_mac safari_mac chrome_android safari_ios
title
required
boolean
hadToday
required
integer format: int64
held
required
integer format: int64
heldZones
required
Array<object>
object
inside
required
boolean
localTime
required
string
subscribers
required
integer format: int64
until
required
string format: date-time
zone
required
string
helpers
required
Array<string>
image
object
bytes
required
integer format: int64
height
required
integer format: int64
mediaId
required
string
name
required
string
url
required
string
width
required
integer format: int64
inside
required
integer format: int64
key
required
string
Allowed values: keys worker audience frequency_cap quiet_hours link lengths image approval
keysAcceptedAt
string format: date-time
keysCreatedAt
string format: date-time
link
string
linkDemo
boolean
linkError
string
linkMillis
integer format: int64
linkStatus
integer format: int64
linked
required
integer format: int64
messageLength
required
integer format: int64
missing
required
Array<string>
otherSites
required
integer format: int64
overCap
required
integer format: int64
quietOff
required
boolean
ratio
string
rules
required
Array<string>
sites
required
Array<object>
object
host
required
string
httpStatus
integer format: int64
status
required
string
Allowed values: built_in found old_version missing unreachable not_a_worker unchecked
subscribers
required
integer format: int64
url
required
string
version
integer format: int64
skipped
required
integer format: int64
status
required
string
Allowed values: pass warn block
titleLength
required
integer format: int64
window
required
string
guards
required
object
cap
required
integer format: int64
held
required
integer format: int64
inside
required
integer format: int64
overCap
required
integer format: int64
quiet
required
boolean
sentToday
required
Array<object>
object
at
required
string format: date-time
by
required
string
kind
required
string
Allowed values: campaign automation
name
required
string
to
required
integer format: int64
unknown
required
integer format: int64
window
required
string
zones
required
Array<object>
object
inside
required
boolean
localTime
required
string
subscribers
required
integer format: int64
until
required
string format: date-time
zone
required
string
id
required
string
name
required
string
schedule
required
object
mode
required
string
Allowed values: now at
outside
required
string
Allowed values: hold skip
sendAt
string format: date-time
ttlMinutes
required
integer format: int64
zone
required
string
send
object
completedAt
string format: date-time
phase
required
string
Allowed values: scheduled sending completed cancelled
recipients
required
integer format: int64
scheduledAt
required
string format: date-time
startedBy
string
sites
required
Array<object>
object
host
required
string
subscribers
required
integer format: int64
status
required
string
test
object
at
required
string format: date-time
browser
required
string
detail
string
platform
required
string
status
required
string
Allowed values: queued sent shown clicked failed
verdict
required
string
Allowed values: ready warnings blocked
version
required
integer format: int64

Example 

{
  "approval": {
    "request": {
      "changes": [
        {
          "field": "subject"
        }
      ],
      "decisions": [
        {
          "decision": "approve"
        }
      ],
      "rules": [
        {
          "key": "audience_min"
        }
      ],
      "snapshot": {
        "scheduleMode": "now"
      },
      "status": "pending",
      "subjectType": "campaign"
    },
    "rules": [
      {
        "key": "audience_min"
      }
    ]
  },
  "checks": [
    {
      "cuts": [
        {
          "platform": "chrome_windows"
        }
      ],
      "key": "keys",
      "sites": [
        {
          "status": "built_in"
        }
      ],
      "status": "pass"
    }
  ],
  "guards": {
    "sentToday": [
      {
        "kind": "campaign"
      }
    ]
  },
  "schedule": {
    "mode": "now",
    "outside": "hold"
  },
  "send": {
    "phase": "scheduled"
  },
  "test": {
    "status": "queued"
  },
  "verdict": "ready"
}

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