Short Codes

Update short code

Changed on

Update the settings for a specific short code. To unbind a short code from a profile, set the messaging_profile_id to null or an empty string. To add or update tags, include the tags field as an array of strings.

patch/short_codes/{id}

Request

  • Base URL: https://api.telnyx.com/v2
  • URL: https://api.telnyx.com/v2/short_codes/{id}
  • Auth: HTTP bearer

Path parameters

idstring uuid required

The id of the short code

Request body

messaging_profile_idstring required

Unique identifier for a messaging profile.

tagsstring[]

Tags associated with the resource.

Example request

{
  "messaging_profile_id": "abc85f64-5717-4562-b3fc-2c9600000000",
  "tags": [
    "test_customer"
  ]
}

Response

Successful response with details about a short code.

Example response

{
  "data": {
    "record_type": "short_code",
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "short_code": "12345",
    "country_code": "US",
    "messaging_profile_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "tags": [
      "test_customer"
    ],
    "created_at": "2019-01-23T18:10:02.574Z",
    "updated_at": "2019-01-23T18:10:02.574Z"
  }
}

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