Skip to main content
POST
/
v1.0
/
message
/
routes
/
update
json
{
  "MessageRouteId": "MRID-73af1e73-d7b3-4696-bdd9-5b407c96fc8a",
  "RouteName": "Updated Webhook",
  "MessageUrl": "https://new-endpoint.com",
  "MessageUrlMethod": "POST"
}
{
  "MessageRouteId": "MRID-01711e7e-c158-4de7-831f-673ab9fdaaa9",
  "AccountId": "DID-1e8939ab-3f3c-4db1-89d7-956d80fd793j",
  "RouteName": "Main SMS Webhook",
  "MessageUrl": "https://apiendpoint.com",
  "MessageUrlMethod": "GET",
  "MessageRouteEnabled": true,
  "MessageAuthenticationType": "Basic",
  "MessageUsername": "admin",
  "MessagePasswordToken": "passwordORbearerToken",
  "CallbackMessageUrl": "https://apiendpoint.com",
  "CallbackMessageUrlMethod": "POST",
  "CallbackMessageAuthenticationType": null,
  "CallbackMessageUsername": null,
  "CallbackMessagePasswordToken": null
}

Authorizations

​
Authorization
string
header
required

Enter the token obtained from the Authentication endpoint

Body

application/json
​
MessageRouteId
string
required

Message Route ID to update

Example:

"MRID-01711e7e-c158-4de7-831f-673ab9fdaaa9"

​
RouteName
string

Friendly name for the message route

Example:

"Main SMS Webhook"

​
MessageUrl
string<uri>

Primary webhook URL

Example:

"https://apiendpoint.com"

​
MessageUrlMethod
enum<string>

HTTP method

Available options:
GET,
POST
Example:

"GET"

​
MessageRouteEnabled
boolean

Enable/disable route

Example:

true

​
MessageAuthenticationType
enum<string>

Authentication type

Available options:
None,
Basic,
Bearer
Example:

"Basic"

​
MessageUsername
string

Username for Basic auth

Example:

"admin"

​
MessagePasswordToken
string

Password or Bearer token

Example:

"passwordORbearerToken"

​
CallbackMessageUrl
string<uri>

Callback webhook URL

Example:

"https://apiendpoint.com"

​
CallbackMessageUrlMethod
enum<string>

Callback HTTP method

Available options:
GET,
POST
Example:

"POST"

​
CallbackMessageAuthenticationType
enum<string>

Callback authentication type

Available options:
None,
Basic,
Bearer
​
CallbackMessageUsername
string

Callback username

​
CallbackMessagePasswordToken
string

Callback password/token

Response

200 - application/json

Update Message Route

The response is of type object.