PUT
/
v1
/
sms
/
routing
/
plans
/
{plan}
/
rules
/
{rule}
cURL
curl --request PUT \
  --url https://api.comm.com/api/v1/sms/routing/plans/{plan}/rules/{rule} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "sms_route_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "country_id": 123,
  "network_id": 123,
  "network_brand_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "is_active": true,
  "priority": 123,
  "action": "send",
  "action_vars": "<string>"
}'
{
  "data": {
    "id": "<string>",
    "sms_route_id": "<string>",
    "sms_routing_plan_id": "<string>",
    "country_id": 123,
    "network_id": 123,
    "network_brand_id": "<string>",
    "is_active": true,
    "priority": 123,
    "action": "<string>",
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z",
    "action_vars": {
      "route_ids": [
        "<string>"
      ],
      "limit": 123
    }
  }
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

plan
string<uuid>
required

The plan ID

rule
string<uuid>
required

The rule ID

Body

application/json
action
enum<string>
required

To create a split rule please check POST ./route/split endpoint.

Available options:
send,
split,
drop,
filter
sms_route_id
string<uuid> | null
country_id
integer | null
network_id
number | null
network_brand_id
string<uuid> | null
is_active
boolean
priority
integer
action_vars
string | null

Response

SmsRoutingPlanRuleResource

data
object
required