Skip to content
ReputeCastReputeCast Docs

Autosave a push campaign (logged)

PATCH
/api/v1/workspaces/{workspace}/push-campaigns/{campaignId}
curl --request PATCH \
  --url https://reputecast.example.com/api/v1/workspaces/acme-newsletter/push-campaigns/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0 \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "buttons": [ { "label": "example", "url": "example" } ], "imageMediaId": "example", "link": "example", "lists": [ "example" ], "message": "example", "name": "example", "replaceTag": true, "segments": [ "example" ], "siteIds": [ "example" ], "tag": "example", "title": "example", "ttlMinutes": 1, "version": 1 }'

Permission: campaigns:edit

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
string format: uuid

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
object
buttons
required
Array<object>
<= 2 items
object
label
required
string
<= 40 characters
url
required
string
<= 2000 characters
imageMediaId
string
<= 40 characters
link
required
string
<= 2000 characters
lists
required
Array<string>
<= 50 items
message
required
string
<= 500 characters
name
required
string
>= 1 characters <= 200 characters
replaceTag
required
boolean
segments
required
Array<string>
<= 50 items
siteIds
required
Array<string>
<= 20 items
tag
required
string
<= 64 characters
title
required
string
<= 200 characters
ttlMinutes
required
integer format: int64
>= 5 <= 40320
version
required
integer format: int64

Example generated

{
  "buttons": [
    {
      "label": "example",
      "url": "example"
    }
  ],
  "imageMediaId": "example",
  "link": "example",
  "lists": [
    "example"
  ],
  "message": "example",
  "name": "example",
  "replaceTag": true,
  "segments": [
    "example"
  ],
  "siteIds": [
    "example"
  ],
  "tag": "example",
  "title": "example",
  "ttlMinutes": 1,
  "version": 1
}

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>
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
autosavedAt
string format: date-time
buttons
required
Array<object>
object
label
required
string
<= 40 characters
url
required
string
<= 2000 characters
createdBy
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
host
required
string
iconUrl
required
string
id
required
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
limits
required
object
message
required
integer format: int64
title
required
integer format: int64
titleWindows
required
integer format: int64
link
required
string
lists
required
Array<object>
object
id
required
string
kind
required
string
Allowed values: list segment
name
required
string
message
required
string
name
required
string
pushOn
required
boolean
replaceTag
required
boolean
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
segments
required
Array<object>
object
id
required
string
kind
required
string
Allowed values: list segment
name
required
string
sites
required
Array<object>
object
host
required
string
id
required
string
selected
required
boolean
subscribers
required
integer format: int64
status
required
string
Allowed values: draft approval approved scheduled sending paused sent cancelled failed
tag
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
title
required
string
ttlMinutes
required
integer format: int64
updatedAt
required
string format: date-time
updatedBy
required
string
utm
required
string
version
required
integer format: int64

Example 

{
  "guards": {
    "sentToday": [
      {
        "kind": "campaign"
      }
    ]
  },
  "lists": [
    {
      "kind": "list"
    }
  ],
  "schedule": {
    "mode": "now",
    "outside": "hold"
  },
  "segments": [
    {
      "kind": "list"
    }
  ],
  "status": "draft",
  "test": {
    "status": "queued"
  }
}

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