Skip to content
ReputeCastReputeCast Docs

Pause a live automation

POST
/api/v1/workspaces/{workspace}/automations/{id}/pause
curl --request POST \
  --url https://reputecast.example.com/api/v1/workspaces/acme-newsletter/automations/example/pause \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "reason": "example" }'

Permission: automations:publish (sensitive)

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

id
required

Automation id

string
<= 40 characters

Automation id

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
object
reason
string
<= 200 characters

Example generated

{
  "reason": "example"
}

Responses

Section titled “Responses”

200

Section titled “200”

OK

Media typeapplication/json
object
changes
required

Unpublished changes, as counted by the version diff

integer format: int64
description
required
string
draftVersion
required
integer format: int64
graph
required
object
edges
required
Array<object>
<= 400 items
object
data
required
object
path
string
<= 16 characters
id
required
string
>= 1 characters <= 80 characters
source
required
string
>= 1 characters <= 40 characters
target
required
string
>= 1 characters <= 40 characters
nodes
required
Array<object>
<= 200 items
object
data
required
object
action
object
kind
required
string
Allowed values: add_list remove_list add_tag remove_tag unsubscribe_all
listId
string
<= 40 characters
tag
string
<= 64 characters
condition

Branch, filter and goal condition

object
event
string
<= 100 characters
field
string
<= 64 characters
humanOnly
boolean
kind
required
string
Allowed values: opened clicked field tag list event bought_product sms_consent sms_clicked sms_replied placed_order
listId
string
<= 40 characters
op

Equals, not_equals, contains, is_set, is_not_set, is_one_of (comma-separated values)

string
<= 16 characters
productId
string
<= 40 characters
step
string
<= 40 characters
store
string
<= 40 characters
tag
string
<= 64 characters
urlContains
string
<= 200 characters
value
string
<= 200 characters
within
object
amount
required
integer format: int64
<= 100000
unit
required
string
Allowed values: minutes hours days weeks
delay
object
amount
required
integer format: int64
<= 100000
unit
required
string
Allowed values: minutes hours days weeks
email
object
emailId
string
<= 40 characters
emailVersion
integer format: int64
route
string
<= 40 characters
sendWindow
object
enabled
required
boolean
end
required
string
<= 5 characters
start
required

HH:MM, recipient-local

string
<= 5 characters
skipListId
string
<= 40 characters
skipRecentHours
integer format: int64
<= 720
subject
string
<= 250 characters
label
string
<= 80 characters
push
object
button
string
<= 40 characters
expiryMinutes
integer format: int64
<= 40320
link
string
<= 2000 characters
message
string
<= 500 characters
outside
string
Allowed values: wait skip ""
title
string
<= 200 characters
sms
object
body
string
<= 1000 characters
consentListId
string
<= 40 characters
noOptOut
boolean
outside
string
Allowed values: wait skip ""
skipRecentHours
integer format: int64
<= 720
trigger
object
afterHours
integer format: int64
<= 24
answerOp
string
Allowed values: any is is_not
answers
Array<integer>
<= 11 items
at
string
<= 5 characters
collections
Array<string>
<= 20 items
confirmedOnly
boolean
direction
string
Allowed values: rises falls
event
string
<= 100 characters
field
string
<= 64 characters
firstOnly
boolean
formId
string
<= 40 characters
includeImports
boolean
kind
required
string
Allowed values: joined_list form_submitted tag_added api_event date_field score_crosses poll_answered bought_product milestone_reached order_placed first_order abandoned_checkout
listId
string
<= 40 characters
milestoneId
string
<= 40 characters
minTotal
integer format: int64
offsetDays
integer format: int64
>= -365 <= 365
onChange
boolean
onceInDays
integer format: int64
<= 3650
poll
string
<= 60 characters
productId
string
<= 40 characters
products
Array<string>
<= 20 items
programId
string
<= 40 characters
reentry
string
<= 8 characters
skipDays
integer format: int64
<= 30
store
string
<= 40 characters
tag
string
<= 64 characters
threshold
integer format: int64
<= 100
yearly
boolean
variants
Array<object>
<= 5 items
object
key
required
string
>= 1 characters <= 4 characters
weight
required
integer format: int64
<= 100
webhook
object
demo
boolean
hasSecret
boolean
method
string
<= 6 characters
name
string
<= 80 characters
url
string
<= 2000 characters
whatsapp
object
consentListId
string
<= 40 characters
fallbackTemplate
string
<= 512 characters
language
string
<= 16 characters
mode
string
Allowed values: template text ""
outside
string
Allowed values: wait skip ""
outsideWindow
string
Allowed values: skip template ""
template
string
<= 512 characters
text
string
<= 1000 characters
variables
Array<object>
<= 20 items
object
fallback
string
<= 500 characters
field
string
<= 64 characters
key
required
string
<= 8 characters
source
required
string
Allowed values: field text
text
string
<= 500 characters
id
required
string
>= 1 characters <= 40 characters /^[A-Za-z0-9_-]+$/
position
required
object
x
required
number format: double
y
required
number format: double
type
required
string
Allowed values: trigger delay email branch filter split webhook list goal exit sms push whatsapp
id
required
string
inFlow
required
integer format: int64
issues
required
Array<object>
object
code
required
string
edgeId
string
message
required
string
nodeId
string
severity
required
string
Allowed values: error warning
liveNodeIds
required
Array<string>
liveVersion
integer format: int64
name
required
string
pauseReason
string
pausedAt
string format: date-time
pausedBy
string
publishedAt
string format: date-time
publishedBy
string
publishedNodeIds
required
Array<string>
revision
required
integer format: int64
route
required
object
fallback
object
adapter
required
string
detail
string
downReason
string
downSince
string format: date-time
id
required
string
lastErrorStatus
integer format: int64
name
required
string
short
required
string
status
required

Healthy, degraded, down, sandbox, warming_up or paused

string
weight
integer format: int64
healthy
required

A provider on the route can send right now

boolean
label
required
string
primary
required
Array<object>
object
adapter
required
string
detail
string
downReason
string
downSince
string format: date-time
id
required
string
lastErrorStatus
integer format: int64
name
required
string
short
required
string
status
required

Healthy, degraded, down, sandbox, warming_up or paused

string
weight
integer format: int64
status
required
string
Allowed values: draft live paused
templateKey
string
updatedAt
required
string format: date-time

Example 

{
  "graph": {
    "nodes": [
      {
        "data": {
          "action": {
            "kind": "add_list"
          },
          "condition": {
            "kind": "opened",
            "within": {
              "unit": "minutes"
            }
          },
          "delay": {
            "unit": "minutes"
          },
          "push": {
            "outside": "wait"
          },
          "sms": {
            "outside": "wait"
          },
          "trigger": {
            "answerOp": "any",
            "direction": "rises",
            "kind": "joined_list"
          },
          "whatsapp": {
            "mode": "template",
            "outside": "wait",
            "outsideWindow": "skip",
            "variables": [
              {
                "source": "field"
              }
            ]
          }
        },
        "type": "trigger"
      }
    ]
  },
  "issues": [
    {
      "severity": "error"
    }
  ],
  "route": {
    "fallback": {
      "name": "Amazon SES",
      "short": "SES"
    },
    "label": "SES, failover Postmark",
    "primary": [
      {
        "name": "Amazon SES",
        "short": "SES"
      }
    ]
  },
  "status": "draft"
}

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