Skip to content

Publish a new version of the text message terms (logged)

PUT
/api/v1/workspaces/{workspace}/sms/terms
curl --request PUT \
--url https://reputecast.example.com/api/v1/workspaces/acme-newsletter/sms/terms \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{ "address": "example", "carriers": "example", "cost": "example", "frequency": "example", "help": "example", "helpEmail": "example", "helpNumber": "example", "intro": "example", "optOut": "example", "privacy": "example", "privacyUrl": "example", "program": "example", "senders": "example" }'

Permission: forms:edit

Consent given from now on records this version.

workspace
required

Workspace slug

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

Workspace slug

Media typeapplication/json
object
address
string
<= 300 characters
carriers
required
string
<= 300 characters
cost
required
string
<= 300 characters
frequency
required
string
<= 300 characters
help
required
string
<= 500 characters
helpEmail
string
<= 200 characters
helpNumber
string
<= 40 characters
intro
required
string
<= 1000 characters
optOut
required
string
<= 500 characters
privacy
required
string
<= 500 characters
privacyUrl
string
<= 500 characters
program
required
string
<= 500 characters
senders
required
string
<= 500 characters

Example generated

{
"address": "example",
"carriers": "example",
"cost": "example",
"frequency": "example",
"help": "example",
"helpEmail": "example",
"helpNumber": "example",
"intro": "example",
"optOut": "example",
"privacy": "example",
"privacyUrl": "example",
"program": "example",
"senders": "example"
}

OK

Media typeapplication/json
object
canEdit
required
boolean
content
required
object
address
string
<= 300 characters
carriers
required
string
<= 300 characters
cost
required
string
<= 300 characters
frequency
required
string
<= 300 characters
help
required
string
<= 500 characters
helpEmail
string
<= 200 characters
helpNumber
string
<= 40 characters
intro
required
string
<= 1000 characters
optOut
required
string
<= 500 characters
privacy
required
string
<= 500 characters
privacyUrl
string
<= 500 characters
program
required
string
<= 500 characters
senders
required
string
<= 500 characters
generated
required
object
address
string
<= 300 characters
carriers
required
string
<= 300 characters
cost
required
string
<= 300 characters
frequency
required
string
<= 300 characters
help
required
string
<= 500 characters
helpEmail
string
<= 200 characters
helpNumber
string
<= 40 characters
intro
required
string
<= 1000 characters
optOut
required
string
<= 500 characters
privacy
required
string
<= 500 characters
privacyUrl
string
<= 500 characters
program
required
string
<= 500 characters
senders
required
string
<= 500 characters
publishedAt
string format: date-time
publishedBy
string
url
required
string
version
required
integer format: int64

Example generated

{
"canEdit": true,
"content": {
"address": "example",
"carriers": "example",
"cost": "example",
"frequency": "example",
"help": "example",
"helpEmail": "example",
"helpNumber": "example",
"intro": "example",
"optOut": "example",
"privacy": "example",
"privacyUrl": "example",
"program": "example",
"senders": "example"
},
"generated": {
"address": "example",
"carriers": "example",
"cost": "example",
"frequency": "example",
"help": "example",
"helpEmail": "example",
"helpNumber": "example",
"intro": "example",
"optOut": "example",
"privacy": "example",
"privacyUrl": "example",
"program": "example",
"senders": "example"
},
"publishedAt": "2026-04-15T12:00:00Z",
"publishedBy": "example",
"url": "example",
"version": 1
}

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