Update Settings

This method is used to update carrier settings.

Request
Request Body schema: application/json

An object containing the settings information that you wish to be updated for a given carrier.

required
object or null

This is a schemaless object used to contain any required fields for updating carrier settings.

transaction_id
required
string <uuid>

The transaction ID uniquely represents this request. If the request is retried then this transaction ID will be the same. You should only perform the requested action once per given transaction ID.

object (Authorization)
object or null
connection_name
string or null

The name of the connection to use, if this app has connection names defined

Responses
200

The Update Settings method updates carrier settings that were set up during the registration of a given carrier

post/UpdateSettings
Request samples
application/json
{
  • "update_settings": {
    },
  • "transaction_id": "0fec1e58-b197-4052-99cf-2218496c5482",
  • "authorization": {
    },
  • "metadata": {
    },
  • "connection_name": "string"
}
Response samples
application/json
{
  • "metadata": {
    }
}