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

idstring

A UUID.

notification_profile_idstring

A UUID reference to the associated Notification Profile.

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

A Channel Type ID

channel_destinationstring

The destination associated with the channel type.

created_atstring date-time

ISO 8601 formatted date indicating when the resource was created.

updated_atstring date-time

ISO 8601 formatted date indicating when the resource was updated.

Example request

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

Response

A Notification Channel response

Example response

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

Changes

Changed in 3 of the 99 revisions of this API.15

  • a6a61a29ecdd6See the full diff
    • ▲

      the // response's property type changed from string to integer, and format from no format to int32 for status

      response-property-type-changed

    • ▲

      the // response's property type changed from string to integer, and format from no format to int32 for status

      response-property-type-changed

    • ▲

      the // response's property type changed from string to integer, and format from no format to int32 for status

      response-property-type-changed

    • ▲

      the /// response's property format changed from json-pointer to no format for status

      response-property-type-changed

    • ▲

      the /// response's property format changed from json-pointer to no format for status

      response-property-type-changed

    • ▲

      the /// response's property format changed from json-pointer to no format for status

      response-property-type-changed

    This revision also has 34 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 1571b0380bd73See the full diff
    • ▲

      the // response's property type changed from integer to string, and format from int32 to no format for status

      response-property-type-changed

    • ▲

      the // response's property type changed from integer to string, and format from int32 to no format for status

      response-property-type-changed

    • ▲

      the // response's property type changed from integer to string, and format from int32 to no format for status

      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 // response's property type changed from string to integer, and format from no format to int32 for status

      response-property-type-changed

    • ▲

      the // response's property type changed from string to integer, and format from no format to int32 for status

      response-property-type-changed

    • ▲

      the // response's property type changed from string to integer, and format from no format to int32 for status

      response-property-type-changed

    • ▲

      the /// response's property format changed from json-pointer to no format for status

      response-property-type-changed

    • ▲

      the /// response's property format changed from json-pointer to no format for status

      response-property-type-changed

    • ▲

      the /// response's property format changed from json-pointer to no format for status

      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

Of the 99 revisions, 1 has no diff computed.