Number Settings

Bulk update phone number profiles

Changed on

Starts a bulk update of messaging-profile assignments for the supplied phone numbers. The response identifies the order used to monitor processing.

post/messaging_numbers_bulk_updates

Request

  • Base URL: https://api.telnyx.com/v2
  • URL: https://api.telnyx.com/v2/messaging_numbers_bulk_updates
  • Auth: HTTP bearer

Request body

messaging_profile_idstring required

Configure the messaging profile these phone numbers are assigned to:

  • Set this field to "" to unassign each number from their respective messaging profile
  • Set this field to a quoted UUID of a messaging profile to assign these numbers to that messaging profile
numbersstring[] required

The list of phone numbers to update.

assign_onlyboolean

If true, only assign numbers to the profile without changing other settings.

Example request

{
  "messaging_profile_id": "00000000-0000-0000-0000-000000000000",
  "numbers": [
    "+18880000000",
    "+18880000001",
    "+18880000002"
  ]
}

Response

Successful response with details about messaging bulk update phone numbers.

Example response

{
  "data": {
    "record_type": "messaging_numbers_bulk_update",
    "order_id": "00000000-0000-0000-0000-000000000000",
    "success": [
      "+18880000000",
      "+18880000001",
      "+18880000002"
    ],
    "pending": [],
    "failed": []
  }
}

Changes

  • 1571b0380bd7Revision changes
    • breaking

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

    • breaking

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

    • breaking

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

  • 8f5f4e537994Revision changes
    • breaking

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

    • breaking

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

    • breaking

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

    • breaking

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