UpdateMessagingProfileRequest

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/telnyx/json-schema/telnyx-update-messaging-profile-request-schema.json",
  "title": "UpdateMessagingProfileRequest",
  "x-generated": "2026-10-30",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/telnyx-profiles-api-openapi.yml#/components/schemas/UpdateMessagingProfileRequest",
  "properties": {
    "alpha_sender": {
      "description": "The alphanumeric sender ID to use when sending to destinations that require an alphanumeric sender ID.",
      "pattern": "^[A-Za-z0-9 ]{1,11}$",
      "type": [
        "string",
        "null"
      ]
    },
    "created_at": {
      "description": "ISO 8601 formatted date indicating when the resource was created.",
      "format": "date-time",
      "readOnly": true,
      "type": "string"
    },
    "daily_spend_limit": {
      "description": "The maximum amount of money (in USD) that can be spent by this profile before midnight UTC.",
      "pattern": "^[0-9]+(?:\\.[0-9]+)?$",
      "type": "string"
    },
    "daily_spend_limit_enabled": {
      "description": "Whether to enforce the value configured by `daily_spend_limit`.",
      "type": "boolean"
    },
    "enabled": {
      "description": "Specifies whether the messaging profile is enabled or not.",
      "type": "boolean"
    },
    "id": {
      "description": "Identifies the type of resource.",
      "format": "uuid",
      "readOnly": true,
      "type": "string"
    },
    "mms_fall_back_to_sms": {
      "default": false,
      "description": "enables SMS fallback for MMS messages.",
      "type": "boolean"
    },
    "mms_transcoding": {
      "default": false,
      "description": "enables automated resizing of MMS media.",
      "type": "boolean"
    },
    "mobile_only": {
      "default": false,
      "description": "Send messages only to mobile phone numbers.",
      "type": "boolean"
    },
    "name": {
      "description": "A user friendly name for the messaging profile.",
      "type": "string"
    },
    "number_pool_settings": {
      "$ref": "#/$defs/NumberPoolSettings"
    },
    "record_type": {
      "description": "Identifies the type of the resource.",
      "enum": [
        "messaging_profile"
      ],
      "readOnly": true,
      "type": "string"
    },
    "smart_encoding": {
      "default": false,
      "description": "Enables automatic character encoding optimization for SMS messages. When enabled, the system automatically selects the most efficient encoding (GSM-7 or UCS-2) based on message content to maximize character limits and minimize costs.",
      "type": "boolean"
    },
    "updated_at": {
      "description": "ISO 8601 formatted date indicating when the resource was updated.",
      "format": "date-time",
      "readOnly": true,
      "type": "string"
    },
    "url_shortener_settings": {
      "$ref": "#/$defs/UrlShortenerSettings"
    },
    "v1_secret": {
      "description": "Secret used to authenticate with v1 endpoints.",
      "type": "string"
    },
    "webhook_api_version": {
      "description": "Determines which webhook format will be used, Telnyx API v1, v2, or a legacy 2010-04-01 format.",
      "enum": [
        "1",
        "2",
        "2010-04-01"
      ],
      "type": "string"
    },
    "webhook_failover_url": {
      "description": "The failover URL where webhooks related to this messaging profile will be sent if sending to the primary URL fails.",
      "format": "url",
      "type": [
        "string",
        "null"
      ]
    },
    "webhook_url": {
      "description": "The URL where webhooks related to this messaging profile will be sent.",
      "format": "url",
      "type": [
        "string",
        "null"
      ]
    },
    "whitelisted_destinations": {
      "description": "Destinations to which the messaging profile is allowed to send. The elements in the list must be valid ISO 3166-1 alpha-2 country codes. If set to `[\"*\"]`, all destinations will be allowed.\n\nThis field is required if the messaging profile doesn't have it defined yet.",
      "items": {
        "description": "ISO 3166-1 alpha-2 country code.",
        "pattern": "^[A-Z]{2}$",
        "type": "string"
      },
      "type": "array"
    }
  },
  "type": "object",
  "$defs": {
    "NumberPoolSettings": {
      "description": "Number Pool allows you to send messages from a pool of numbers of different types, assigning\nweights to each type. The pool consists of all the long code and toll free numbers\nassigned to the messaging profile.\n\nTo disable this feature, set the object field to `null`.\n",
      "properties": {
        "geomatch": {
          "default": false,
          "description": "If set to true, Number Pool will try to choose a sending number with the same area code as the destination\nnumber. If there are no such numbers available, a nunber with a different area code will be chosen. Currently\nonly NANP numbers are supported.\n",
          "type": "boolean"
        },
        "long_code_weight": {
          "description": "Defines the probability weight for a Long Code number to be selected when sending a message.\nThe higher the weight the higher the probability. The sum of the weights for all number types\ndoes not necessarily need to add to 100.  Weight must be a non-negative number, and when equal\nto zero it will remove the number type from the pool.\n",
          "type": "number"
        },
        "skip_unhealthy": {
          "description": "If set to true all unhealthy numbers will be automatically excluded from the pool.\nHealth metrics per number are calculated on a regular basis, taking into account the deliverability\nrate and the amount of messages marked as spam by upstream carriers.\nNumbers with a deliverability rate below 25% or spam ratio over 75% will be considered unhealthy.\n",
          "type": "boolean"
        },
        "sticky_sender": {
          "default": false,
          "description": "If set to true, Number Pool will try to choose the same sending number for all messages to a particular\nrecipient. If the sending number becomes unhealthy and `skip_unhealthy` is set to true, a new\nnumber will be chosen.\n",
          "type": "boolean"
        },
        "toll_free_weight": {
          "description": "Defines the probability weight for a Toll Free number to be selected when sending a message.\nThe higher the weight the higher the probability. The sum of the weights for all number types\ndoes not necessarily need to add to 100. Weight must be a non-negative number, and when equal\nto zero it will remove the number type from the pool.\n",
          "type": "number"
        }
      },
      "required": [
        "toll_free_weight",
        "long_code_weight",
        "skip_unhealthy"
      ],
      "type": [
        "object",
        "null"
      ]
    },
    "UrlShortenerSettings": {
      "description": "The URL shortener feature allows automatic replacement of URLs that were generated using\na public URL shortener service. Some examples include bit.do, bit.ly, goo.gl, ht.ly,\nis.gd, ow.ly, rebrand.ly, t.co, tiny.cc, and tinyurl.com. Such URLs are replaced with\nwith links generated by Telnyx. The use of custom links can improve branding and message\ndeliverability.\n\nTo disable this feature, set the object field to `null`.\n",
      "properties": {
        "domain": {
          "description": "One of the domains provided by the Telnyx URL shortener service.\n",
          "type": "string"
        },
        "prefix": {
          "description": "Optional prefix that can be used to identify your brand, and will appear in the Telnyx generated URLs after the domain name.\n",
          "type": "string"
        },
        "replace_blacklist_only": {
          "description": "Use the link replacement tool only for links that are specifically blacklisted by Telnyx.\n",
          "type": "boolean"
        },
        "send_webhooks": {
          "description": "Receive webhooks for when your replaced links are clicked. Webhooks are sent to the webhooks on the messaging profile.\n",
          "type": "boolean"
        }
      },
      "required": [
        "domain"
      ],
      "type": [
        "object",
        "null"
      ]
    }
  }
}