Update a notification channel

Update a notification channel.

PATCH /notification_channels/{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 notificationChannel = await client.notificationChannels.update(
  '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
);

console.log(notificationChannel.data);

200

{
  "data": {
    "id": "12455643-3cf1-4683-ad23-1cd32f7d5e0a",
    "notification_profile_id": "12455643-3cf1-4683-ad23-1cd32f7d5e0a",
    "channel_type_id": "sms",
    "channel_destination": "[phone]",
    "created_at": "2019-10-15T10:07:15.527Z",
    "updated_at": "2019-10-15T10:07:15.527Z"
  }
}

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 resource.

Body

application/json

Update notification channel object

A Notification Channel

notification_profile_id · string

A UUID reference to the associated Notification Profile.

Example:

"12455643-3cf1-4683-ad23-1cd32f7d5e0a"

channel_type_id · enum<string>

A Channel Type ID

Available options: sms, voice, email, webhook

channel_destination · string

The destination associated with the channel type.

Example:

"[phone]"

Response

200

application/json

A Notification Channel response

data · object

A Notification Channel

Show child attributes