Skip to content
ReputeCastReputeCast Docs

Autosave an SMS campaign (logged)

PATCH
/api/v1/workspaces/{workspace}/sms-campaigns/{campaignId}
curl --request PATCH \
  --url https://reputecast.example.com/api/v1/workspaces/acme-newsletter/sms-campaigns/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0 \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "body": "example", "lists": [ "example" ], "name": "example", "segments": [ "example" ], "version": 1 }'

Permission: campaigns:edit

Answers 409 version_conflict when someone saved a newer version.

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

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
object
body
string
<= 2000 characters
lists
Array<string>
<= 20 items
name
string
<= 200 characters
segments
Array<string>
<= 20 items
version
required
integer format: int64
>= 1

Example generated

{
  "body": "example",
  "lists": [
    "example"
  ],
  "name": "example",
  "segments": [
    "example"
  ],
  "version": 1
}

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>
audience
required
Array<object>
object
id
required
string
kind
required
string
Allowed values: list segment
name
required
string
autosavedAt
string format: date-time
blocks
required
integer format: int64
body
required
string
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
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
counter
required
object
base
required
integer format: int64
capacity
required
integer format: int64
characters
required
integer format: int64
encoding
required
string
Allowed values: gsm7 ucs2
fields
required
Array<object>
object
fallback
required
string
hasFallback
required
boolean
key
required
string
fill
required
Array<integer>
left
required
integer format: int64
longest
object
characters
required
integer format: int64
cost
required
number format: double
name
required
string
recipients
required
integer format: int64
segments
required
integer format: int64
value
required
string
outside
required
Array<object>
object
char
required
string
count
required
integer format: int64
first
required
integer format: int64
kind
required
string
Allowed values: curly_apostrophe curly_quote en_dash em_dash minus ellipsis non_breaking_space thin_space zero_width_space prime backtick emoji other
removable
required
boolean
replacement
required
string
segments
required
integer format: int64
spread
required
Array<object>
object
recipients
required
integer format: int64
segments
required
integer format: int64
units
required
integer format: int64
createdBy
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
id
required
string
links
required
Array<object>
object
host
required
string
length
required
integer format: int64
shortener
required
boolean
url
required
string
utmCampaign
required
string
localDate
string
localTime
string
name
required
string
optOut
required
string
prefix
required
string
priceProviders
required
Array<string>
pricedOn
string format: date-time
retentionDays
required
integer format: int64
routes
required
Array<object>
object
adapter
required
string
countries
required
Array<string>
provider
required
string
recipients
required
integer format: int64
sender
required
string
skipped
string
scheduleMode
required
string
Allowed values: now at local
segments
required
integer format: int64
sendAt
string format: date-time
shortDomain
required
string
shortDomainStatus
required
string
Allowed values: none pending verified failed
status
required
string
Allowed values: draft approval approved scheduled sending paused sent cancelled failed
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
text
required
string
texts
required
integer format: int64
timezone
required
string
updatedAt
required
string format: date-time
updatedBy
required
string
version
required
integer format: int64
versions
required
integer format: int64
warnings
required
integer format: int64
window
required
string

Example 

{
  "audience": [
    {
      "kind": "list"
    }
  ],
  "counter": {
    "encoding": "gsm7",
    "outside": [
      {
        "kind": "curly_apostrophe"
      }
    ]
  },
  "scheduleMode": "now",
  "shortDomainStatus": "none",
  "status": "draft",
  "tests": [
    {
      "lastTest": {
        "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