Sign in
Notifications

Create a notification channel

Creates a new notification channel defining where notifications are delivered, and returns the created channel.

post/notification_channels

Request body

channel_destinationstring

The destination associated with the channel type.

channel_type_id'sms' | 'voice' | 'email' | 'webhook'

A Channel Type ID

created_atstring date-time

ISO 8601 formatted date indicating when the resource was created.

idstring

A UUID.

notification_profile_idstring

A UUID reference to the associated Notification Profile.

updated_atstring date-time

ISO 8601 formatted date indicating when the resource was updated.

Example request

{
  "channel_destination": "+13125550000",
  "created_at": "2019-10-15T10:07:15.527Z",
  "id": "12455643-3cf1-4683-ad23-1cd32f7d5e0a",
  "notification_profile_id": "12455643-3cf1-4683-ad23-1cd32f7d5e0a",
  "updated_at": "2019-10-15T10:07:15.527Z"
}

Response

A Notification Channel response

Example response

{
  "data": {
    "channel_destination": "+13125550000",
    "created_at": "2019-10-15T10:07:15.527Z",
    "id": "12455643-3cf1-4683-ad23-1cd32f7d5e0a",
    "notification_profile_id": "12455643-3cf1-4683-ad23-1cd32f7d5e0a",
    "updated_at": "2019-10-15T10:07:15.527Z"
  }
}

Changes

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

  • 1571b0380bd73See the full diff
    • ▲

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

      response-property-type-changed

    • ▲

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

      response-property-type-changed

    • ▲

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

      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

  • 8f5f4e5379946See the full diff
    • ▲

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

      response-property-type-changed

    • ▲

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

      response-property-type-changed

    • ▲

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

      response-property-type-changed

    • ▲

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

      response-property-type-changed

    • ▲

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

      response-property-type-changed

    • ▲

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

      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