Change a sender's countries (logged)

PATCH

/api/v1/workspaces/{workspace}/sms/senders/{senderId}

curl --request PATCH \
  --url https://reputecast.example.com/api/v1/workspaces/acme-newsletter/sms/senders/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0 \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "countries": [ "example" ] }'

• Your ReputeCast public URL

Permission: providers:manage (sensitive)

Authorizations

• bearer

Parameters

Path Parameters

workspace

required

Workspace slug

string

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

Workspace slug

senderId

required

Sender id

string format: uuid

Sender id

Request Body^required

Media typeapplication/json

object

countries

required

Array<string>

>= 1 items <= 60 items

Example ^generated

{
  "countries": [
    "example"
  ]
}

Responses

200

OK

Media typeapplication/json

object

items

required

Array<object>

object

adapter

required

string

brand

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

campaign

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

canSend

required

boolean

countries

required

Array<string>

held

required

boolean

id

required

string

kind

required

string

Allowed values: toll_free 10dlc local mobile sender_id

label

required

string

manual

required

boolean

provider

required

string

providerId

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

routes

required

Array<Array<string>>

throughput

required

number format: double

value

required

string

Example

{
  "items": [
    {
      "brand": {
        "kind": "toll_free",
        "source": "api",
        "status": "not_registered"
      },
      "campaign": {
        "kind": "toll_free",
        "source": "api",
        "status": "not_registered"
      },
      "kind": "toll_free",
      "registration": {
        "kind": "toll_free",
        "source": "api",
        "status": "not_registered"
      }
    }
  ]
}

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