Skip to content
ReputeCastReputeCast Docs

An approval request with its snapshot, readiness, diff and discussion

GET
/api/v1/workspaces/{workspace}/approvals/{approvalId}
curl --request GET \
  --url https://reputecast.example.com/api/v1/workspaces/acme-newsletter/approvals/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0 \
  --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

approvalId
required
string format: uuid

Responses

Section titled “Responses”

200

Section titled “200”

OK

Media typeapplication/json
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
audience
object
changePct
required
number format: double
count
required
integer format: int64
current
required
integer format: int64
excluded
required
string
lists
required
Array<string>
audit
object
action
required
string
actor
required
string
at
required
string format: date-time
ip
string
author
required
object
color
required
string
email
required
string
id
required
string
initials
required
string
name
required
string
presence
string
role
required
string
automation
object
changes
required
Array<string>
migration
required
string
version
required
integer format: int64
bypassReason
string
campaign
object
currentVersion
required
integer format: int64
editedAt
string format: date-time
editedBy
string
from
required
string
id
required
string
preheader
required
string
scheduledAt
string format: date-time
status
required
string
subject
required
string
version
required
integer format: int64
can
required
object
cancel
required
boolean
comment
required
boolean
decide
required
boolean
decideReason
string
isAuthor
required
boolean
remind
required
boolean
restore
required
boolean
schedule
required
boolean
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
changesSince
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
channel
required
string
Allowed values: email sms push whatsapp
clientSignoff
object
approvers
required
Array<string>
met
required
boolean
signedOffBy
string
staffApprovals
required
Array<string>
viewerIsStaff
required
boolean
comment
string
comments
required
Array<object>
object
at
required
string format: date-time
author
required
object
color
required
string
email
required
string
id
required
string
initials
required
string
name
required
string
presence
string
role
required
string
body
required
string
id
required
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
held
object
blocks
required
Array<object>
object
ack
string
ackKey
string
detail
string
evidence
string
fixes
required
Array<object>
object
action
string
Allowed values: exclude_sunset route_only insert_footer replace_link use_subject minify mark_language_up_to_date mark_language_translated hold_language release_language accessibility_decorative accessibility_color accessibility_one_click visibility_show_everyone visibility_hide_block visibility_remove_condition poll_close_days exclude_risky verify_addresses sponsor_remove_block sponsor_refresh_block
href
string
kind
required
string
Allowed values: apply link
label
required
string
params
object
key
additional properties
string
tone
string
Allowed values: primary danger
flatTitle
required
string
group
required
string
Allowed values: reputation authentication content languages links compliance audience routing accessibility conditional
key
required
string
label
string
mono
boolean
note
string
rows
Array<object>
object
count
required
integer format: int64
detail
required
string
gets
string
getsName
string
label
required
string
language
string
short
string
status
required
string
Allowed values: pass warn block unknown
title
required
string
held
required
integer format: int64
reason
required
string
since
required
string format: date-time
id
required
string
invalidatedAt
string format: date-time
invalidatedBy
string
invalidatedFields
string
invalidatedReason
string
name
required
string
needed
required
integer format: int64
nextId
string
note
required
string
page
object
name
required
string
pageId
required
string
path
required
string
publishAt
string format: date-time
published
required
boolean
slug
required
string
template
required
string
visibility
required
string
Allowed values: public members paid
visibilityLabel
required
string
when
required
string
Allowed values: now at
push
object
buttons
required
Array<object>
object
label
required
string
url
required
string
host
string
icon
string
image
string
link
required
string
message
required
string
recipients
required
integer format: int64
schedule
required
string
sites
required
Array<string>
tag
string
title
required
string
ttlMinutes
required
integer format: int64
readiness
object
blocks
required
integer format: int64
checkedAt
required
string format: date-time
issues
required
Array<object>
object
ack
string
ackKey
string
detail
string
evidence
string
fixes
required
Array<object>
object
action
string
Allowed values: exclude_sunset route_only insert_footer replace_link use_subject minify mark_language_up_to_date mark_language_translated hold_language release_language accessibility_decorative accessibility_color accessibility_one_click visibility_show_everyone visibility_hide_block visibility_remove_condition poll_close_days exclude_risky verify_addresses sponsor_remove_block sponsor_refresh_block
href
string
kind
required
string
Allowed values: apply link
label
required
string
params
object
key
additional properties
string
tone
string
Allowed values: primary danger
flatTitle
required
string
group
required
string
Allowed values: reputation authentication content languages links compliance audience routing accessibility conditional
key
required
string
label
string
mono
boolean
note
string
rows
Array<object>
object
count
required
integer format: int64
detail
required
string
gets
string
getsName
string
label
required
string
language
string
short
string
status
required
string
Allowed values: pass warn block unknown
title
required
string
passed
required
integer format: int64
total
required
integer format: int64
verdict
required
string
Allowed values: ready warnings blocked
warnings
required
integer format: int64
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
route
object
shares
required
Array<object>
object
color
required
string
Allowed values: ses postal postmark other
cost
required
number format: double
label
string
name
required
string
priceLabel
required
string
providerId
required
string
recipients
required
integer format: int64
short
required
string
status
required
string
statusLabel
required
string
splitLabel
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
schedule
object
at
string format: date-time
autoPause
required
string
minutes
required
integer format: int64
mode
required
string
Allowed values: now at best_time
timezone
required
string
sms
object
body
required
string
chars
required
integer format: int64
cost
required
number format: double
countries
required
Array<object>
object
cost
required
number format: double
country
required
string
price
required
number format: double
provider
required
string
recipients
required
integer format: int64
sender
required
string
skipped
required
boolean
encoding
required
string
optOut
required
string
prefix
required
string
recipients
required
integer format: int64
schedule
required
string
segments
required
integer format: int64
text
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
transactional
object
breaking
string
category
required
string
contentSummary
required
string
draftRevision
required
integer format: int64
key
required
string
liveVersion
integer format: int64
name
required
string
passed
required
integer format: int64
published_version
integer format: int64
subjectAfter
string
subjectBefore
string
templateId
required
string
testRenders
required
Array<object>
object
name
required
string
ok
required
boolean
variables
required
Array<string>
version
required
integer format: int64
warnings
required
integer format: int64
version
required
integer format: int64
website
object
excerpt
required
string
kind
required
string
Allowed values: campaign web
path
required
string
postId
required
string
publishAt
string format: date-time
published
required
boolean
slug
required
string
title
required
string
visibility
required
string
Allowed values: public members paid
visibilityLabel
required
string
when
required
string
Allowed values: now at with_send
whatsapp
object
body
required
string
business
required
string
buttons
required
Array<string>
category
required
string
cost
required
number format: double
language
required
string
number
required
string
preview
required
string
recipients
required
integer format: int64
schedule
required
string
template
required
string
variables
required
Array<object>
object
fallback
string
key
required
string
source
required
string

Example 

{
  "changes": [
    {
      "field": "subject"
    }
  ],
  "changesSince": [
    {
      "field": "subject"
    }
  ],
  "channel": "email",
  "decisions": [
    {
      "decision": "approve"
    }
  ],
  "held": {
    "blocks": [
      {
        "fixes": [
          {
            "action": "exclude_sunset",
            "kind": "apply",
            "tone": "primary"
          }
        ],
        "group": "reputation",
        "status": "pass"
      }
    ]
  },
  "page": {
    "visibility": "public",
    "when": "now"
  },
  "readiness": {
    "issues": [
      {
        "fixes": [
          {
            "action": "exclude_sunset",
            "kind": "apply",
            "tone": "primary"
          }
        ],
        "group": "reputation",
        "status": "pass"
      }
    ],
    "verdict": "ready"
  },
  "route": {
    "shares": [
      {
        "color": "ses"
      }
    ]
  },
  "rules": [
    {
      "key": "audience_min"
    }
  ],
  "schedule": {
    "mode": "now"
  },
  "snapshot": {
    "scheduleMode": "now"
  },
  "status": "pending",
  "subjectType": "campaign",
  "website": {
    "kind": "campaign",
    "visibility": "public",
    "when": "now"
  }
}

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