v52

OpenAPI 3.1.0raw.githubusercontent.com2026-07-311,1941,9384.1 MB

Messaging

Update a messaging hosted number

Update the messaging settings for a hosted number.

patch/messaging_hosted_numbers/{id}

Path parameters

idstring required

The ID or phone number of the hosted number.

Request body

messaging_productstring

Configure the messaging product for this number:

Omit this field or set its value to null to keep the current value.
Set this field to a quoted product ID to set this phone number to that product

messaging_profile_idstring

Configure the messaging profile this phone number is assigned to:

Omit this field or set its value to null to keep the current value.
Set this field to "" to unassign the number from its messaging profile
Set this field to a quoted UUID of a messaging profile to assign this number to that messaging profile

tagsstring[]

Tags to set on this phone number.

Example request

{
  "messaging_product": "P2P",
  "messaging_profile_id": "dd50eba1-a0c0-4563-9925-b25e842a7cb6"
}

Response

Successful response with the updated hosted number.

Example response

{
  "data": {
    "country_code": "US",
    "created_at": "2019-01-23T18:10:02.574Z",
    "eligible_messaging_products": [
      "A2P"
    ],
    "features": {
      "mms": null,
      "sms": {
        "domestic_two_way": true,
        "international_inbound": true,
        "international_outbound": true
      }
    },
    "health": {
      "inbound_outbound_ratio": 0.43,
      "message_count": 122,
      "spam_ratio": 0.06,
      "success_ratio": 0.94
    },
    "id": "1293384261075731499",
    "messaging_product": "A2P",
    "messaging_profile_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "phone_number": "+18005550001",
    "record_type": "messaging_settings",
    "traffic_type": "A2P",
    "type": "tollfree",
    "updated_at": "2019-01-23T18:10:02.574Z"
  }
}