Skip to main content
POST
json

Body

application/json
RouteName
string
required

Friendly name for the message route

Example:

"Main SMS Webhook"

MessageUrl
string<uri>
required

Primary webhook URL for inbound messages

Example:

"https://apiendpoint.com"

MessageUrlMethod
enum<string>
required

HTTP method for webhook delivery

Available options:
GET,
POST
Example:

"POST"

MessageRouteEnabled
boolean
default:true

Enable or disable this message route

Example:

true

MessageAuthenticationType
enum<string>

Authentication type for primary webhook

Available options:
None,
Basic,
Bearer
Example:

"Basic"

MessageUsername
string

Username for Basic auth (if applicable)

Example:

"admin"

MessagePasswordToken
string

Password for Basic auth or token for Bearer auth

Example:

"passwordORbearerToken"

CallbackMessageUrl
string<uri>

Fallback/callback webhook URL

Example:

"https://apiendpoint.com"

CallbackMessageUrlMethod
enum<string>

HTTP method for callback webhook

Available options:
GET,
POST
Example:

"POST"

CallbackMessageAuthenticationType
enum<string>

Authentication type for callback webhook

Available options:
None,
Basic,
Bearer
Example:

"Basic"

CallbackMessageUsername
string

Username for callback Basic auth

Example:

"admin"

CallbackMessagePasswordToken
string

Password/token for callback auth

Example:

"password"

InboundBypass
boolean

Bypass AI Guardian filtering for inbound messages on this route

Example:

true

OutboundBypass
boolean

Bypass AI Guardian filtering for outbound messages on this route

Example:

true

IntelligentRouteEnabled
boolean

Enable intelligent routing features (AI-assisted message routing)

Example:

true

AccountId
string

Account ID to associate with this message route

Example:

"DID-eab92510-1040-45a5-bb9c-0bad927SDY878W"

Response

Success — returns the newly created Message Route ID (MRID)

The response is of type object.