Skip to main content

Update a 'TN'

PATCH 
/messaging/numbers/:tn

Update the specific phone number's messaging settings.

Request​

Path Parameters

    tn stringrequired

    E.164 formatted phone number (without the plus sign)

Body

required

    profile_id uuid

    ID of the existing messaging profile to which the phone number should be assigned

    msg_product string

    The messaging product to which the phone number should be registered

Responses​

200: Updated 'TN'

Schema

    num stringrequired

    +E.164 formatted phone number

    user_id uuidrequired

    ID of user who owns the phone number

    profile_id uuid

    ID of messaging profile, or '' if unassigned

    last_updated integer

    Possible values: Value must match regular expression ^(([0-9]{16})|0)$

    Default value: 0

    Updated at time (Unix time in microseconds), or '0' if unknown

    country_code string

    Number's Country Code

    campaign_id string

    The messaging campaign ID associated with the short-code

    num_country string

    Possible values: Value must match regular expression ^(([A-Z]{3}))$

    The ISO 3166-1 alpha-3 country code of the country of origin for the number

    traffic_type string

    The messaging product the number is registered with

    num_type string

    The type of the phone number

    sms

    object

    The SMS features associated with the phone number

    enabled booleanrequired

    False if the features are not currently enabled, true if the features are currently enabled.

    domestic_two_way booleanrequired

    Domestic two way messaging feature

    international_inbound booleanrequired

    International inbound messaging feature

    international_outbound booleanrequired

    International outbound messaging feature

    The SMS features associated with the phone number

    mms

    object

    The MMS features associated with the phone number

    enabled booleanrequired

    False if the features are not currently enabled, true if the features are currently enabled.

    domestic_two_way booleanrequired

    Domestic two way messaging feature

    international_inbound booleanrequired

    International inbound messaging feature

    international_outbound booleanrequired

    International outbound messaging feature

    The MMS features associated with the phone number

Request samples

curl -L -X PATCH 'https://sms.telnyx.com/messaging/numbers/:tn' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-d '{
  "profile_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "msg_product": [
    "A2P",
    "P2P"
  ]
}'

Response samples

{
  "num": "+13129457420",
  "user_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "profile_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "last_updated": 1521566241103171,
  "country_code": "string",
  "campaign_id": "string",
  "num_country": "USA",
  "traffic_type": "P2P",
  "num_type": "long-code",
  "sms": {
    "enabled": true,
    "domestic_two_way": true,
    "international_inbound": true,
    "international_outbound": true
  },
  "mms": {
    "enabled": true,
    "domestic_two_way": true,
    "international_inbound": true,
    "international_outbound": true
  }
}