Update a messaging profile

Updates the specified messaging profile with the values of the parameters passed. Any parameters not included in the request will be left unchanged.

Request
path Parameters
profile_id
required
string <uuid>

ID of messaging profile

Request Body schema: application/json
required

Updates requested

name
string

A user friendly name for the messaging profile.

enabled
boolean

Specifies whether the messaging profile is enabled or not.

incoming_webhook_url
string

The URL where webhooks for inbound messages to numbers on this messaging profile will be sent. (Previously called "url".)

incoming_failover_url
string

The failover URL where webhooks for inbound messages to numbers on this messaging profile will be sent, if sending to the primary URL fails. (Previously called "failover_url".)

webhook_api_version
string

Determines which webhook format will be used, Telnyx API v1, v2, or a legacy 2010-04-01 format.

Enum: "1" "2" "2010-04-01"
whitelisted_destinations
Array of strings

Destinations to which the messaging profile is allowed to send. If set to null, all destinations will be allowed. Setting a value of ["*"] has the equivalent effect. The elements in the list must be valid ISO 3166-1 alpha-2 country codes.

alpha_sender
string^[A-Za-z0-9 ]{1,11}$

DEPRECATED: Alphanumeric Sender IDs can be set dynamically in the /messages request.

object (NumberPoolSettings)
Default: null

Number Pool allows you to send messages from a pool of numbers of different types, assigning weights to each type. The pool consists of all the long code and toll free numbers assigned to the messaging profile.

To disable this feature, set the object field to null.

object (UrlShortenerSettings)
Default: null

The URL shortener feature allows automatic replacement of URLs that were generated using a public URL shortener service. Some examples include bit.do, bit.ly, goo.gl, ht.ly, is.gd, ow.ly, rebrand.ly, t.co, tiny.cc, and tinyurl.com. Such URLs are replaced with with links generated by Telnyx. The use of custom links can improve branding and message deliverability.

To disable this feature, set the object field to null.

Responses
200

Updated messaging profile

patch/messaging/profiles/{profile_id}
Request samples
application/json
{
  • "name": "string",
  • "enabled": true,
  • "incoming_webhook_url": "https://www.example.com/hooks",
  • "incoming_failover_url": "https://www.example.com/callbacks",
  • "webhook_api_version": "1",
  • "whitelisted_destinations": [
    ],
  • "alpha_sender": "Telnyx",
  • "number_pool_settings": null,
  • "url_shortener_settings": null
}
Response samples
application/json
{
  • "user_id": "834f3d53-8a3c-4aa0-a733-7f2d682a72df",
  • "profile_id": "834f3d53-8a3c-4aa0-a733-7f2d682a72df",
  • "name": "string",
  • "enabled": true,
  • "secret": "rq789onm321yxzkjihfEdcBAmmijjoik",
  • "incoming_webhook_url": "https://www.example.com/hooks",
  • "incoming_failover_url": "https://www.example.com/callbacks",
  • "webhook_api_version": "1",
  • "whitelisted_destinations": [
    ],
  • "alpha_sender": "Telnyx",
  • "number_pool_settings": null,
  • "url_shortener_settings": null
}