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}

JavaScript

JavaScript

import Telnyx from 'telnyx';

const client = new Telnyx({
  apiKey: process.env['TELNYX_API_KEY'], // This is the default and can be omitted
});

const shortCode = await client.shortCodes.update('182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e', {
  messaging_profile_id: 'abc85f64-5717-4562-b3fc-2c9600000000',
});

console.log(shortCode.data);

200

{
  "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"
  }
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

id · string<uuid> · required

The id of the short code

Body

application/json

Short code update

messaging_profile_id · string · required

Unique identifier for a messaging profile.

tags · string[]

Response

200

application/json

Successful response with details about a short code.

data · object

Show child attributes

Example:

{
  "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"
}