Sign in
Number Settings

Update the messaging profile and/or messaging product of a phone number

Updates the messaging product, messaging profile, or both for the specified phone number.

patch/phone_numbers/{id}/messaging

Path parameters

idstring required

The phone number to update.

Request body

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
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
tagsstring[]

Tags to set on this phone number.

Example request

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

Response

Successful response with details about a phone number including messaging settings.

Example response

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

Changes

Changed in 2 of the 99 revisions of this API.7

  • 1571b0380bd73See the full diff
    • ▲

      the response's body type changed from object to no type for status

      response-body-type-changed

    • ▲

      the / response's property type changed from object to no type for status

      response-property-type-changed

    • ▲

      the // response's property type changed from integer to string, and format from int32 to no format for status

      response-property-type-changed

    This revision also has 64 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 8f5f4e5379944See the full diff
    • ▲

      the response's body type changed from no type to object for status

      response-body-type-changed

    • ▲

      the / response's property type changed from no type to object for status

      response-property-type-changed

    • ▲

      the // response's property type changed from string to integer, and format from no format to int32 for status

      response-property-type-changed

    • ▲

      the /// response's property format changed from json-pointer to no format for status

      response-property-type-changed

    This revision also has 41 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

Of the 99 revisions, 1 has no diff computed.