PUT
/
v1
/
sms
/
routing
/
routes
/
{route}
cURL
curl --request PUT \
  --url https://api.comm.com/api/v1/sms/routing/routes/{route} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "<string>",
  "description": "<string>",
  "connection_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "clicks_webhook_url": "<string>"
}'
{
  "data": {
    "id": "<string>",
    "name": "<string>",
    "company_id": "<string>",
    "company": {
      "id": "<string>",
      "team_id": "<string>",
      "name": "<string>",
      "created_at": "<string>",
      "updated_at": "<string>",
      "is_active": true,
      "overdraft_enabled": true,
      "overdraft_limit": 123,
      "client_balance": "<string>",
      "vendor_balance": "<string>",
      "provider_balance": 123,
      "provider_balance_updated_at": "<string>",
      "balance_checker": "<string>",
      "endpoints_count": "<string>",
      "sms_routes_count": "<string>",
      "balance_checker_data": {
        "balance_checker": "api",
        "balance_regex": "<string>",
        "api_auth_type": "none",
        "api_auth_data": [
          "<string>"
        ],
        "balance_endpoint_url": "<string>",
        "balance_endpoint_method": "GET",
        "balance_json_path": "<string>",
        "notification_if_no_data_x_days": 2
      },
      "balance_email": "<string>",
      "links": [
        "<string>"
      ]
    },
    "connection": "<string>",
    "is_connected": true,
    "connection_id": "<string>",
    "rates_total": 123,
    "created_at": "2023-11-07T05:31:56Z",
    "links": {
      "delete": "<string>"
    },
    "client_balance": 123,
    "vendor_balance": 123,
    "queue_info": [
      "<any>"
    ]
  }
}

Authorizations

Authorization
string
header
required

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

Path Parameters

route
string<uuid>
required

The route ID

Body

application/json

Response

200
application/json

SmsRoutingRouteResource

The response is of type object.