Get a notification channel

GET 
/notification_channels/:id

Get a notification channel.

Request

Path Parameters

id uuidrequired

The id of the resource.

Responses

200: A Notification Channel response

application/json

• Schema
• Example (from schema)

Schema

data

NotificationChannel

A Notification Channel

id string

A UUID.

notification_profile_id string

A UUID reference to the associated Notification Profile.

channel_type_id string

Possible values: [sms, voice, email, webhook]

A Channel Type ID

channel_destination string

The destination associated with the channel type.

created_at date-time

ISO 8601 formatted date indicating when the resource was created.

updated_at date-time

ISO 8601 formatted date indicating when the resource was updated.

A Notification Channel

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

default: Unexpected error

application/json

• Schema
• Example (from schema)

Schema

errors

Error[]

Array [

code intrequired

title stringrequired

detail string

source

object

pointer json-pointer

JSON pointer (RFC6901) to the offending entity.

parameter string

Indicates which query parameter caused the error.

meta object

]

{
  "errors": [
    {
      "code": "string",
      "title": "string",
      "detail": "string",
      "source": {
        "pointer": "string",
        "parameter": "string"
      },
      "meta": {}
    }
  ]
}

Loading...