Sign in
Short Codes

Update short code

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}

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

Changes

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

  • 1571b0380bd73See the full diff
    • ▲

      the response's body type/format changed from object/ to / for status 4XX

      response-body-type-changed

    • ▲

      the errors/items/ response's property type/format changed from object/ to / for status 4XX

      response-property-type-changed

    • ▲

      the errors/items/code response's property type/format changed from integer/int32 to string/ for status 4XX

      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/format changed from / to object/ for status 4XX

      response-body-type-changed

    • ▲

      the errors/items/ response's property type/format changed from / to object/ for status 4XX

      response-property-type-changed

    • ▲

      the errors/items/code response's property type/format changed from string/ to integer/int32 for status 4XX

      response-property-type-changed

    • ▲

      the errors/items/source/pointer response's property type/format changed from string/json-pointer to string/ for status 4XX

      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