Skip to content
ReputeCastReputeCast Docs

Review & send: the SMS checks, routes, cost, schedule and approvals

GET
/api/v1/workspaces/{workspace}/sms-campaigns/{campaignId}/review
curl --request GET \
  --url https://reputecast.example.com/api/v1/workspaces/acme-newsletter/sms-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
canManageRules
required
boolean
canSend
required
boolean
canViewContacts
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
blocks
required
integer format: int64
budget
required
object
after
required
number format: double
alertPct
required
integer format: int64
budget
required
number format: double
month
required
string format: date-time
setAt
string format: date-time
setBy
string
spent
required
number format: double
campaign
required
object
autosavedAt
string format: date-time
id
required
string
name
required
string
status
required
string
Allowed values: draft approval approved scheduled sending paused sent cancelled failed
text
required
string
updatedBy
required
string
version
required
integer format: int64
checkedAt
required
string format: date-time
checks
required
Array<object>
object
after
required
number format: double
alertPct
required
integer format: int64
budget
required
number format: double
byArea
required
integer format: int64
byCountry
required
integer format: int64
characters
required
integer format: int64
choice
string
Allowed values: skip wait ""
clearedAt
string format: date-time
clearedBy
string
cost
required
number format: double
count
required
integer format: int64
countries
required
Array<string>
domain
string
encoding
string
key
required
string
Allowed values: audience senders registration routes consent suppressions quiet_hours time_zones opt_out sender_named links length budget
links
required
integer format: int64
lists
required
Array<string>
local
string
provider
string
reasons
required
object
key
additional properties
integer format: int64
registration
string
remaining
required
number format: double
segments
required
integer format: int64
sender
string
senders
required
Array<object>
object
countries
required
Array<string>
registration
required
string
sender
required
string
since
string format: date-time
shorteners
required
Array<string>
since
string format: date-time
spent
required
number format: double
status
required
string
Allowed values: pass warn block
text
string
total
required
integer format: int64
verifiedOn
string format: date-time
window
string
cost
required
number format: double
costs
required
Array<object>
object
adapter
required
string
cost
required
number format: double
country
required
string
pendingPrice
required
number format: double
price
required
number format: double
provider
required
string
recipients
required
integer format: int64
segments
required
integer format: int64
sender
required
string
senderKind
required
string
skipReason
string
skipped
required
integer format: int64
defaults
required
object
failed
required
number format: double
>= 0.1 <= 100
filtered
required
number format: double
>= 0.1 <= 100
optOuts
required
number format: double
>= 0.1 <= 100
fingerprint
required
string
funnel
required
object
assumed
required
integer format: int64
base
required
integer format: int64
canReceive
required
integer format: int64
noConsent
required
integer format: int64
reasons
required
object
key
additional properties
integer format: int64
shared
required
integer format: int64
skipped
required
integer format: int64
skippedIn
required
Array<string>
suppressed
required
integer format: int64
toSend
required
integer format: int64
large
required
object
cost
required
number format: double
recipients
required
integer format: int64
required
required
boolean
lists
required
Array<string>
passed
required
integer format: int64
pendingPolicy
required
string
Allowed values: skip wait
policy
required
object
audienceMin
required
integer format: int64
audienceRule
required
boolean
authorLacksSend
required
boolean
costAmount
required
number format: double
costRule
required
boolean
preview
required
object
arrives
string format: date-time
canReply
required
boolean
characters
required
integer format: int64
confirmation
object
at
required
string format: date-time
text
required
string
contact
required
string
contactId
string
country
required
string
encoding
required
string
parts
required
Array<object>
object
kind
required
string
Allowed values: fixed text link
text
required
string
price
required
number format: double
provider
required
string
segments
required
integer format: int64
sender
required
string
senderKind
required
string
skipped
string
zone
required
string
pricedOn
string format: date-time
routes
required
Array<object>
object
adapter
required
string
cost
required
number format: double
provider
required
string
rate
required
number format: double
recipients
required
integer format: int64
seconds
required
number format: double
sender
required
string
share
required
number format: double
schedule
required
object
end
string format: date-time
groups
required
Array<object>
object
countries
required
Array<string>
from
required
string format: date-time
held
required
boolean
localFrom
required
string
localTo
required
string
recipients
required
integer format: int64
to
required
string format: date-time
until
required
string format: date-time
localDate
string
localTime
string
mode
required
string
Allowed values: now at local
now
required
Array<object>
object
countries
required
Array<string>
from
required
string format: date-time
held
required
boolean
localFrom
required
string
localTo
required
string
recipients
required
integer format: int64
to
required
string format: date-time
until
required
string format: date-time
sendAt
string format: date-time
window
required
string
windowFrom
required
integer format: int64
windowTo
required
integer format: int64
segments
required
integer format: int64
segmentsEach
required
integer format: int64
send
object
pausedAt
string format: date-time
pausedKind
required
string
Allowed values: auto person outage budget ""
phase
required
string
Allowed values: scheduled sending paused completed cancelled
scheduledAt
required
string format: date-time
startedBy
required
string
tests
required
Array<object>
object
color
required
string
country
required
string
display
required
string
id
required
string
lastTest
object
at
required
string format: date-time
delivered
string format: date-time
messageId
required
string
provider
required
string
seconds
number format: double
sender
required
string
senderId
required
boolean
status
required
string
Allowed values: queued held skipped sending sent delivered undelivered failed cancelled
name
required
string
phone
required
string
role
required
string
userId
string
texts
required
integer format: int64
thresholds
required
object
failed
required
number format: double
>= 0.1 <= 100
filtered
required
number format: double
>= 0.1 <= 100
optOuts
required
number format: double
>= 0.1 <= 100
timezone
required
string
verdict
required
string
Allowed values: ready warnings blocked
warnings
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"
      }
    ]
  },
  "campaign": {
    "status": "draft"
  },
  "checks": [
    {
      "choice": "skip",
      "key": "audience",
      "status": "pass"
    }
  ],
  "pendingPolicy": "skip",
  "preview": {
    "parts": [
      {
        "kind": "fixed"
      }
    ]
  },
  "schedule": {
    "mode": "now"
  },
  "send": {
    "pausedKind": "auto",
    "phase": "scheduled"
  },
  "tests": [
    {
      "lastTest": {
        "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