Skip to content
ReputeCastReputeCast Docs

Replace the routes by country (logged)

PUT
/api/v1/workspaces/{workspace}/sms/routes
curl --request PUT \
  --url https://reputecast.example.com/api/v1/workspaces/acme-newsletter/sms/routes \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "other": "dont_send", "otherRoute": 1, "routes": [ { "countries": [ "example" ], "fallbackId": "example", "senderId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0" } ] }'

Permission: providers:manage (sensitive)

A country takes one route; a fallback must be registered for the route’s countries.

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

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
object
other
required
string
Allowed values: dont_send route
otherRoute
integer format: int64
routes
required
Array<object>
<= 100 items
object
countries
required
Array<string>
>= 1 items <= 250 items
fallbackId
string
senderId
required
string format: uuid

Responses

Section titled “Responses”

200

Section titled “200”

OK

Media typeapplication/json
object
alertPct
required
integer format: int64
assumed
required
integer format: int64
brandPrefix
required
string
budget
required
number format: double
budgetSetAt
string format: date-time
budgetSetBy
string
canManage
required
boolean
confirmation
required
object
count
required
object
capacity
required
integer format: int64
characters
required
integer format: int64
encoding
required
string
Allowed values: gsm7 ucs2
fill
required
Array<integer>
left
required
integer format: int64
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
units
required
integer format: int64
text
required
string
confirmationOn
required
boolean
gaps
required
Array<object>
object
countries
required
Array<string>
held
required
integer format: int64
people
required
integer format: int64
sender
required
string
since
string format: date-time
status
required
string
helpKeywords
required
Array<string>
helpReply
required
object
count
required
object
capacity
required
integer format: int64
characters
required
integer format: int64
encoding
required
string
Allowed values: gsm7 ucs2
fill
required
Array<integer>
left
required
integer format: int64
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
units
required
integer format: int64
text
required
string
helpers
required
Array<string>
keywordsBy
required
string
Allowed values: reputecast provider
members
required
Array<object>
object
color
required
string
name
required
string
role
required
string
userId
required
string
month
required
string format: date-time
optInKeywords
required
Array<string>
optInReply
required
object
count
required
object
capacity
required
integer format: int64
characters
required
integer format: int64
encoding
required
string
Allowed values: gsm7 ucs2
fill
required
Array<integer>
left
required
integer format: int64
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
units
required
integer format: int64
text
required
string
optOutInSteps
required
boolean
optOutKeywords
required
Array<string>
optOutReply
required
object
count
required
object
capacity
required
integer format: int64
characters
required
integer format: int64
encoding
required
string
Allowed values: gsm7 ucs2
fill
required
Array<integer>
left
required
integer format: int64
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
units
required
integer format: int64
text
required
string
optOutText
required
string
other
required
string
Allowed values: dont_send route
otherPeople
required
integer format: int64
otherRouteId
string
providerAnswers
required
Array<string>
pushWindow
required
boolean
quietFrom
required
string
quietTo
required
string
requireYes
required
boolean
retentionDays
required
integer format: int64
routes
required
Array<object>
object
adapter
required
string
countries
required
Array<string>
fallback
string
fallbackId
string
fallbackProvider
string
id
required
string
onLists
required
integer format: int64
provider
required
string
registration
required
object
country
required
string
kind
required
string
Allowed values: toll_free brand campaign sender_id ""
name
string
readAt
string format: date-time
reason
string
setBy
string
since
string format: date-time
source
required
string
Allowed values: api manual rule ""
status
required
string
Allowed values: not_registered pending verified approved rejected allowed not_supported
sender
required
string
senderId
required
string
senderKind
required
string
skipped
required
boolean
senders
required
Array<object>
object
adapter
required
string
countries
required
Array<string>
id
required
string
kind
required
string
label
required
string
provider
required
string
sendable
required
Array<string>
shortDomain
required
object
checkedAt
string format: date-time
detail
string
domain
required
string
status
required
string
Allowed values: none pending verified failed
target
required
string
verifiedAt
string format: date-time
spent
required
number format: double
testNumbers
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
testsCost
required
number format: double
testsSent
required
integer format: int64
thresholds
required
object
failed
required
number format: double
>= 0.1 <= 100
filtered
required
number format: double
>= 0.1 <= 100
optOuts
required
number format: double
>= 0.1 <= 100
timezone
required
string
updatedAt
string format: date-time
updatedBy
string
whatsAppWindow
required
boolean
zones
required
Array<object>
object
inside
required
boolean
local
required
string
opens
required
string
zone
required
string

Example 

{
  "confirmation": {
    "count": {
      "encoding": "gsm7",
      "outside": [
        {
          "kind": "curly_apostrophe"
        }
      ]
    }
  },
  "helpReply": {
    "count": {
      "encoding": "gsm7",
      "outside": [
        {
          "kind": "curly_apostrophe"
        }
      ]
    }
  },
  "keywordsBy": "reputecast",
  "optInReply": {
    "count": {
      "encoding": "gsm7",
      "outside": [
        {
          "kind": "curly_apostrophe"
        }
      ]
    }
  },
  "optOutReply": {
    "count": {
      "encoding": "gsm7",
      "outside": [
        {
          "kind": "curly_apostrophe"
        }
      ]
    }
  },
  "other": "dont_send",
  "routes": [
    {
      "registration": {
        "kind": "toll_free",
        "source": "api",
        "status": "not_registered"
      }
    }
  ],
  "shortDomain": {
    "status": "none"
  },
  "testNumbers": [
    {
      "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