Run Send Readiness on a campaign now

POST

/api/v1/workspaces/{workspace}/campaigns/{campaignId}/readiness

package main

import (
  "fmt"
  "net/http"
  "io"
)

func main() {

  url := "https://reputecast.example.com/api/v1/workspaces/acme-newsletter/campaigns/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/readiness"

  req, _ := http.NewRequest("POST", url, nil)

  req.Header.Add("Authorization", "Bearer <token>")

  res, _ := http.DefaultClient.Do(req)

  defer res.Body.Close()
  body, _ := io.ReadAll(res.Body)

  fmt.Println(res)
  fmt.Println(string(body))

}

const url = 'https://reputecast.example.com/api/v1/workspaces/acme-newsletter/campaigns/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/readiness';
const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request POST \
  --url https://reputecast.example.com/api/v1/workspaces/acme-newsletter/campaigns/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/readiness \
  --header 'Authorization: Bearer <token>'

Permission: campaigns:edit

Runs every check and stores the result. Fails with 409 readiness_running while a run is in progress; poll …/readiness/progress.

Authorizations

bearer

Parameters

Path Parameters

workspace

required

Workspace slug

string

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

Workspace slug

campaignId

required

string format: uuid

Responses

200

application/json

object

campaignId

required

string

checks

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

counts

required

object

blocks

required

integer format: int64

passed

required

integer format: int64

total

required

integer format: int64

unknown

required

integer format: int64

warnings

required

integer format: int64

durationMs

required

integer format: int64

estimates

required

object

audience

required

object

duplicates

required

integer format: int64

final

required

integer format: int64

lists

required

Array<string>

role

required

integer format: int64

rows

required

Array<object>

object

count

required

integer format: int64

kind

required

string

Allowed values: base minus plus

label

required

string

suppressed

required

integer format: int64

unengaged

required

integer format: int64

unengagedExcluded

required

boolean

route

required

object

down

required

integer format: int64

move

object

addCost

required

number format: double

addMinutes

required

integer format: int64

from

required

string

required

string

toId

required

string

override

required

boolean

policy

required

string

Allowed values: automatic pause_and_ask warm_only

shares

required

Array<object>

object

adapter

required

string

available

required

boolean

color

required

string

Allowed values: ses postal postmark other

cost

required

number format: double

label

string

minutes

required

integer format: int64

name

required

string

percent

required

number format: double

priceLabel

required

string

pricing

required

string

Allowed values: metered plan self_hosted

providerId

required

string

rate

required

number format: double

rateLabel

required

string

recipients

required

integer format: int64

short

required

string

status

required

string

statusLabel

required

string

warmupDay

integer format: int64

warmupDays

integer format: int64

splitLabel

required

string

stream

required

string

Allowed values: broadcast automation system

streamLabel

required

string

totalCost

required

number format: double

totalMinutes

required

integer format: int64

throttling

required

Array<object>

object

key

required

string

Allowed values: gmail outlook yahoo icloud other

name

required

string

rate

required

number format: double

recipients

required

integer format: int64

groups

required

Array<object>

object

caption

required

string

key

required

string

Allowed values: reputation authentication content languages links compliance audience routing accessibility conditional

note

string

passed

required

integer format: int64

running

required

string

status

required

string

Allowed values: pass warn block unknown

summary

required

string

title

required

string

total

required

integer format: int64

required

string

incomplete

required

boolean

problem

string

ranAt

required

string format: date-time

ranBy

string

trigger

required

string

Allowed values: manual composer schedule send_time approval

unknownAcceptedAt

string format: date-time

unknownAcceptedBy

string

verdict

required

string

Allowed values: ready warnings blocked

version

required

integer format: int64

Example

{
  "checks": [
    {
      "fixes": [
        {
          "action": "exclude_sunset",
          "kind": "apply",
          "tone": "primary"
        }
      ],
      "group": "reputation",
      "status": "pass"
    }
  ],
  "estimates": {
    "audience": {
      "rows": [
        {
          "kind": "base"
        }
      ]
    },
    "route": {
      "policy": "automatic",
      "shares": [
        {
          "color": "ses",
          "pricing": "metered"
        }
      ],
      "stream": "broadcast"
    },
    "throttling": [
      {
        "key": "gmail"
      }
    ]
  },
  "groups": [
    {
      "key": "reputation",
      "status": "pass"
    }
  ],
  "trigger": "manual",
  "verdict": "ready"
}

default

Error

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