Notifications API

Notification settings operations API

List notification channels

List notification channels.

SecuritybearerAuth
Request
query Parameters
page[number]
integer >= 1
Default: 1

The page number to load

page[size]
integer [ 1 .. 250 ]
Default: 20

The size of the page

filter[channel_type_id][eq]
string

Filter by the id of a channel type

Enum: "webhook" "sms" "email" "voice"
Example: filter[channel_type_id][eq]=webhook
Responses
200

Returns a list of notification channels.

Response Schema: application/json
Array of objects (NotificationChannel)
object (PaginationMeta)
default

Unexpected error

Response Schema: application/json
Array of objects (Error)
Array
code
required
string <int>
detail
string
meta
object
object
title
required
string
get/notification_channels
Request samples 
Response samples 
application/json
{
  • "data": [
    • {
      • "channel_destination": "+13125550000",
      • "channel_type_id": "sms",
      • "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"
      }
    ],
  • "meta": {
    • "page_number": 2,
    • "page_size": 25,
    • "total_pages": 3,
    • "total_results": 55
    }
}
Create a notification channel
Create a notification channel.


SecuritybearerAuth 
Request 
Request Body schema: application/json
Add a Notification Channel


channel_destination
string
The destination associated with the channel type.


 
channel_type_id
string
A Channel Type ID


 Enum: "sms" "voice" "email" "webhook"  
notification_profile_id
string
A UUID reference to the associated Notification Profile.


 
Responses 
200
A Notification Channel response


Response Schema: application/json
object (NotificationChannel) 
A Notification Channel


 
channel_destination
string
The destination associated with the channel type.


 
channel_type_id
string
A Channel Type ID


 Enum: "sms" "voice" "email" "webhook"  
created_at
string <date-time> 
ISO 8601 formatted date indicating when the resource was created.


 
id
string
A UUID.


 
notification_profile_id
string
A UUID reference to the associated Notification Profile.


 
updated_at
string <date-time> 
ISO 8601 formatted date indicating when the resource was updated.


 
default
Unexpected error


Response Schema: application/json
Array of objects (Error) 
 
 Array 
code
required
string <int> 
 
detail
string
 
meta
object
 
object
 
title
required
string
 
post/notification_channels
Request samples 
application/json
{
  • "channel_destination": "+13125550000",
  • "channel_type_id": "sms",
  • "notification_profile_id": "12455643-3cf1-4683-ad23-1cd32f7d5e0a"
}
Response samples 
application/json
{
  • "data": {
    • "channel_destination": "+13125550000",
    • "channel_type_id": "sms",
    • "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"
    }
}
Delete a notification channel
Delete a notification channel.


SecuritybearerAuth 
Request 
path Parameters
id
required
string <uuid> 
Identifies the resource.


 
 Example:  6a09cdc3-8948-47f0-aa62-74ac943d6c58
Responses 
200
A Notification Channel response


Response Schema: application/json
object (NotificationChannel) 
A Notification Channel


 
channel_destination
string
The destination associated with the channel type.


 
channel_type_id
string
A Channel Type ID


 Enum: "sms" "voice" "email" "webhook"  
created_at
string <date-time> 
ISO 8601 formatted date indicating when the resource was created.


 
id
string
A UUID.


 
notification_profile_id
string
A UUID reference to the associated Notification Profile.


 
updated_at
string <date-time> 
ISO 8601 formatted date indicating when the resource was updated.


 
default
Unexpected error


Response Schema: application/json
Array of objects (Error) 
 
 Array 
code
required
string <int> 
 
detail
string
 
meta
object
 
object
 
title
required
string
 
delete/notification_channels/{id}
Request samples 
Response samples 
application/json
{
  • "data": {
    • "channel_destination": "+13125550000",
    • "channel_type_id": "sms",
    • "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"
    }
}
Retrieve a notification channel
Retrieve a notification channel.


SecuritybearerAuth 
Request 
path Parameters
id
required
string <uuid> 
Identifies the resource.


 
 Example:  6a09cdc3-8948-47f0-aa62-74ac943d6c58
Responses 
200
A Notification Channel response


Response Schema: application/json
object (NotificationChannel) 
A Notification Channel


 
channel_destination
string
The destination associated with the channel type.


 
channel_type_id
string
A Channel Type ID


 Enum: "sms" "voice" "email" "webhook"  
created_at
string <date-time> 
ISO 8601 formatted date indicating when the resource was created.


 
id
string
A UUID.


 
notification_profile_id
string
A UUID reference to the associated Notification Profile.


 
updated_at
string <date-time> 
ISO 8601 formatted date indicating when the resource was updated.


 
default
Unexpected error


Response Schema: application/json
Array of objects (Error) 
 
 Array 
code
required
string <int> 
 
detail
string
 
meta
object
 
object
 
title
required
string
 
get/notification_channels/{id}
Request samples 
import telnyx
telnyx.api_key = "YOUR_API_KEY"

telnyx.NotificationChannel.retrieve("id")
Response samples 
application/json
{
  • "data": {
    • "channel_destination": "+13125550000",
    • "channel_type_id": "sms",
    • "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"
    }
}
Update a notification channel
Update a notification channel.


SecuritybearerAuth 
Request 
path Parameters
id
required
string <uuid> 
Identifies the resource.


 
 Example:  6a09cdc3-8948-47f0-aa62-74ac943d6c58
Request Body schema: application/json
required
Update notification channel object


channel_destination
string
The destination associated with the channel type.


 
channel_type_id
string
A Channel Type ID


 Enum: "sms" "voice" "email" "webhook"  
notification_profile_id
string
A UUID reference to the associated Notification Profile.


 
Responses 
200
A Notification Channel response


Response Schema: application/json
object (NotificationChannel) 
A Notification Channel


 
channel_destination
string
The destination associated with the channel type.


 
channel_type_id
string
A Channel Type ID


 Enum: "sms" "voice" "email" "webhook"  
created_at
string <date-time> 
ISO 8601 formatted date indicating when the resource was created.


 
id
string
A UUID.


 
notification_profile_id
string
A UUID reference to the associated Notification Profile.


 
updated_at
string <date-time> 
ISO 8601 formatted date indicating when the resource was updated.


 
default
Unexpected error


Response Schema: application/json
Array of objects (Error) 
 
 Array 
code
required
string <int> 
 
detail
string
 
meta
object
 
object
 
title
required
string
 
patch/notification_channels/{id}
Request samples 
application/json
{
  • "channel_destination": "+13125550000",
  • "channel_type_id": "sms",
  • "notification_profile_id": "12455643-3cf1-4683-ad23-1cd32f7d5e0a"
}
Response samples 
application/json
{
  • "data": {
    • "channel_destination": "+13125550000",
    • "channel_type_id": "sms",
    • "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"
    }
}
List all Notifications Events Conditions
Returns a list of your notifications events conditions.


SecuritybearerAuth 
Request 
query Parameters
page[number]
integer  >= 1 
 Default:  1
The page number to load


 
page[size]
integer  [ 1 .. 250 ] 
 Default:  20
The size of the page


 
filter[associated_record_type][eq]
string
Filter by the associated record type


 Enum: "account" "phone_number"  
 Example:  filter[associated_record_type][eq]=phone_number
Responses 
200
Returns a list of notification event conditions available.


Response Schema: application/json
Array of objects (NotificationEventCondition) 
 
object (PaginationMeta) 
 
default
Unexpected error


Response Schema: application/json
Array of objects (Error) 
 
 Array 
code
required
string <int> 
 
detail
string
 
meta
object
 
object
 
title
required
string
 
get/notification_event_conditions
Request samples 
Response samples 
application/json
{
  • "data": [
    • {
      • "allow_multiple_channels": false,
      • "associated_record_type": "phone_number",
      • "asynchronous": true,
      • "created_at": "2019-10-15T10:07:15.527Z",
      • "description": "When emergency number dialed from phone number X",
      • "enabled": true,
      • "id": "70c7c5cb-dce2-4124-accb-870d39dbe852",
      • "name": "from phone number",
      • "notification_event_id": "d5c395cd-9864-4609-b5e2-3f9fd4ce201a",
      • "parameters": [
        • {
          • "data_type": "string",
          • "name": "phone_number",
          • "optional": false
          }
        ],
      • "supported_channels": [
        • "webhook",
        • "sms",
        • "email",
        • "voice"
        ],
      • "updated_at": "2019-10-15T10:07:15.527Z"
      }
    ],
  • "meta": {
    • "page_number": 2,
    • "page_size": 25,
    • "total_pages": 3,
    • "total_results": 55
    }
}
List all Notifications Events
Returns a list of your notifications events.


SecuritybearerAuth 
Request 
query Parameters
page[number]
integer  >= 1 
 Default:  1
The page number to load


 
page[size]
integer  [ 1 .. 250 ] 
 Default:  20
The size of the page


 
Responses 
200
Returns a list of notification events available.


Response Schema: application/json
Array of objects (NotificationEvent) 
 
object (PaginationMeta) 
 
default
Unexpected error


Response Schema: application/json
Array of objects (Error) 
 
 Array 
code
required
string <int> 
 
detail
string
 
meta
object
 
object
 
title
required
string
 
get/notification_events
Request samples 
Response samples 
application/json
{
  • "data": [
    • {
      • "created_at": "2019-10-15T10:07:15.527Z",
      • "enabled": true,
      • "id": "d5c395cd-9864-4609-b5e2-3f9fd4ce201a",
      • "name": "Emergency Number Dialed",
      • "notification_category": "Calls",
      • "updated_at": "2019-10-15T10:07:15.527Z"
      }
    ],
  • "meta": {
    • "page_number": 2,
    • "page_size": 25,
    • "total_pages": 3,
    • "total_results": 55
    }
}
List all Notifications Profiles
Returns a list of your notifications profiles.


SecuritybearerAuth 
Request 
query Parameters
page[number]
integer  >= 1 
 Default:  1
The page number to load


 
page[size]
integer  [ 1 .. 250 ] 
 Default:  20
The size of the page


 
Responses 
200
Returns a list of notification profiles.


Response Schema: application/json
Array of objects (NotificationProfile) 
 
object (PaginationMeta) 
 
default
Unexpected error


Response Schema: application/json
Array of objects (Error) 
 
 Array 
code
required
string <int> 
 
detail
string
 
meta
object
 
object
 
title
required
string
 
get/notification_profiles
Request samples 
Response samples 
application/json
{
  • "data": [
    • {
      • "created_at": "2019-10-15T10:07:15.527Z",
      • "id": "12455643-3cf1-4683-ad23-1cd32f7d5e0a",
      • "name": "string",
      • "updated_at": "2019-10-15T10:07:15.527Z"
      }
    ],
  • "meta": {
    • "page_number": 2,
    • "page_size": 25,
    • "total_pages": 3,
    • "total_results": 55
    }
}
Create a notification profile
Create a notification profile.


SecuritybearerAuth 
Request 
Request Body schema: application/json
Add a Notification Profile


name
string
A human readable name.


 
Responses 
200
A Notification Profile response


Response Schema: application/json
object (NotificationProfile) 
A Collection of Notification Channels


 
created_at
string <date-time> 
ISO 8601 formatted date indicating when the resource was created.


 
id
string
A UUID.


 
name
string
A human readable name.


 
updated_at
string <date-time> 
ISO 8601 formatted date indicating when the resource was updated.


 
default
Unexpected error


Response Schema: application/json
Array of objects (Error) 
 
 Array 
code
required
string <int> 
 
detail
string
 
meta
object
 
object
 
title
required
string
 
post/notification_profiles
Request samples 
application/json
{
  • "name": "string"
}
Response samples 
application/json
{
  • "data": {
    • "created_at": "2019-10-15T10:07:15.527Z",
    • "id": "12455643-3cf1-4683-ad23-1cd32f7d5e0a",
    • "name": "string",
    • "updated_at": "2019-10-15T10:07:15.527Z"
    }
}
Delete a notification profile
Delete a notification profile.


SecuritybearerAuth 
Request 
path Parameters
id
required
string <uuid> 
Identifies the resource.


 
 Example:  6a09cdc3-8948-47f0-aa62-74ac943d6c58
Responses 
200
A Notification Profile response


Response Schema: application/json
object (NotificationProfile) 
A Collection of Notification Channels


 
created_at
string <date-time> 
ISO 8601 formatted date indicating when the resource was created.


 
id
string
A UUID.


 
name
string
A human readable name.


 
updated_at
string <date-time> 
ISO 8601 formatted date indicating when the resource was updated.


 
default
Unexpected error


Response Schema: application/json
Array of objects (Error) 
 
 Array 
code
required
string <int> 
 
detail
string
 
meta
object
 
object
 
title
required
string
 
delete/notification_profiles/{id}
Request samples 
Response samples 
application/json
{
  • "data": {
    • "created_at": "2019-10-15T10:07:15.527Z",
    • "id": "12455643-3cf1-4683-ad23-1cd32f7d5e0a",
    • "name": "string",
    • "updated_at": "2019-10-15T10:07:15.527Z"
    }
}
Retrieve a notification profile
Retrieve a notification profile.


SecuritybearerAuth 
Request 
path Parameters
id
required
string <uuid> 
Identifies the resource.


 
 Example:  6a09cdc3-8948-47f0-aa62-74ac943d6c58
Responses 
200
A Notification Profile response


Response Schema: application/json
object (NotificationProfile) 
A Collection of Notification Channels


 
created_at
string <date-time> 
ISO 8601 formatted date indicating when the resource was created.


 
id
string
A UUID.


 
name
string
A human readable name.


 
updated_at
string <date-time> 
ISO 8601 formatted date indicating when the resource was updated.


 
default
Unexpected error


Response Schema: application/json
Array of objects (Error) 
 
 Array 
code
required
string <int> 
 
detail
string
 
meta
object
 
object
 
title
required
string
 
get/notification_profiles/{id}
Request samples 
Response samples 
application/json
{
  • "data": {
    • "created_at": "2019-10-15T10:07:15.527Z",
    • "id": "12455643-3cf1-4683-ad23-1cd32f7d5e0a",
    • "name": "string",
    • "updated_at": "2019-10-15T10:07:15.527Z"
    }
}
Update a notification profile
Update a notification profile.


SecuritybearerAuth 
Request 
path Parameters
id
required
string <uuid> 
Identifies the resource.


 
 Example:  6a09cdc3-8948-47f0-aa62-74ac943d6c58
Request Body schema: application/json
required
Update notification profile object


name
string
A human readable name.


 
Responses 
200
A Notification Profile response


Response Schema: application/json
object (NotificationProfile) 
A Collection of Notification Channels


 
created_at
string <date-time> 
ISO 8601 formatted date indicating when the resource was created.


 
id
string
A UUID.


 
name
string
A human readable name.


 
updated_at
string <date-time> 
ISO 8601 formatted date indicating when the resource was updated.


 
default
Unexpected error


Response Schema: application/json
Array of objects (Error) 
 
 Array 
code
required
string <int> 
 
detail
string
 
meta
object
 
object
 
title
required
string
 
patch/notification_profiles/{id}
Request samples 
application/json
{
  • "name": "string"
}
Response samples 
application/json
{
  • "data": {
    • "created_at": "2019-10-15T10:07:15.527Z",
    • "id": "12455643-3cf1-4683-ad23-1cd32f7d5e0a",
    • "name": "string",
    • "updated_at": "2019-10-15T10:07:15.527Z"
    }
}
List notification settings
List notification settings.


SecuritybearerAuth 
Request 
query Parameters
page[number]
integer  >= 1 
 Default:  1
The page number to load


 
page[size]
integer  [ 1 .. 250 ] 
 Default:  20
The size of the page


 
filter[notification_profile_id][eq]
string
Filter by the id of a notification profile


 
 Example:  filter[notification_profile_id][eq]=12455643-3cf1-4683-ad23-1cd32f7d5e0a
filter[notification_channel][eq]
string
Filter by the id of a notification channel


 
 Example:  filter[notification_channel][eq]=12455643-3cf1-4683-ad23-1cd32f7d5e0a
filter[notification_event_condition_id][eq]
string
Filter by the id of a notification channel


 
 Example:  filter[notification_event_condition_id][eq]=12455643-3cf1-4683-ad23-1cd32f7d5e0a
filter[associated_record_type][eq]
string
Filter by the associated record type


 Enum: "account" "phone_number"  
 Example:  filter[associated_record_type][eq]=phone_number
filter[status][eq]
string
The status of a notification setting


 Enum: "enabled" "enable-received" "enable-pending" "enable-submtited" "delete-received" "delete-pending" "delete-submitted" "deleted"  
 Example:  filter[status][eq]=enable-received
Responses 
200
Returns a list of notification settings.


Response Schema: application/json
Array of objects (NotificationSetting) 
 
object (PaginationMeta) 
 
default
Unexpected error


Response Schema: application/json
Array of objects (Error) 
 
 Array 
code
required
string <int> 
 
detail
string
 
meta
object
 
object
 
title
required
string
 
get/notification_settings
Request samples 
Response samples 
application/json
{
  • "data": [
    • {
      • "associated_record_type": "phone_number",
      • "associated_record_type_value": "+13125550000",
      • "created_at": "2019-10-15T10:07:15.527Z",
      • "id": "8eb5b5f9-5893-423c-9f15-b487713d44d4",
      • "notification_channel_id": "12455643-3cf1-4683-ad23-1cd32f7d5e0a",
      • "notification_event_condition_id": "70c7c5cb-dce2-4124-accb-870d39dbe852",
      • "notification_profile_id": "12455643-3cf1-4683-ad23-1cd32f7d5e0a",
      • "parameters": [
        • {
          • "name": "phone_number",
          • "value": "+13125550000"
          }
        ],
      • "status": "enable-received",
      • "updated_at": "2019-10-15T10:07:15.527Z"
      }
    ],
  • "meta": {
    • "page_number": 2,
    • "page_size": 25,
    • "total_pages": 3,
    • "total_results": 55
    }
}
Add a Notification Setting
Add a notification setting.


SecuritybearerAuth 
Request 
Request Body schema: application/json
notification_channel_id
string
A UUID reference to the associated Notification Channel.


 
notification_event_condition_id
string
A UUID reference to the associated Notification Event Condition.


 
notification_profile_id
string
A UUID reference to the associated Notification Profile.


 
Array of objects
 
Responses 
200
A Notification Setting response


Response Schema: application/json
object (NotificationSetting) 
 
associated_record_type
string
 
associated_record_type_value
string
 
created_at
string <date-time> 
ISO 8601 formatted date indicating when the resource was created.


 
id
string
A UUID.


 
notification_channel_id
string
A UUID reference to the associated Notification Channel.


 
notification_event_condition_id
string
A UUID reference to the associated Notification Event Condition.


 
notification_profile_id
string
A UUID reference to the associated Notification Profile.


 
Array of objects
 
status
string
Most preferences apply immediately; however, other may needs to propagate.


 Enum: "enabled" "enable-received" "enable-pending" "enable-submtited" "delete-received" "delete-pending" "delete-submitted" "deleted"  
updated_at
string <date-time> 
ISO 8601 formatted date indicating when the resource was updated.


 
201
A Notification Setting response - async


Response Schema: application/json
object (NotificationSetting) 
 
associated_record_type
string
 
associated_record_type_value
string
 
created_at
string <date-time> 
ISO 8601 formatted date indicating when the resource was created.


 
id
string
A UUID.


 
notification_channel_id
string
A UUID reference to the associated Notification Channel.


 
notification_event_condition_id
string
A UUID reference to the associated Notification Event Condition.


 
notification_profile_id
string
A UUID reference to the associated Notification Profile.


 
Array of objects
 
status
string
Most preferences apply immediately; however, other may needs to propagate.


 Enum: "enabled" "enable-received" "enable-pending" "enable-submtited" "delete-received" "delete-pending" "delete-submitted" "deleted"  
updated_at
string <date-time> 
ISO 8601 formatted date indicating when the resource was updated.


 
default
Unexpected error


Response Schema: application/json
Array of objects (Error) 
 
 Array 
code
required
string <int> 
 
detail
string
 
meta
object
 
object
 
title
required
string
 
post/notification_settings
Request samples 
application/json
{
  • "notification_channel_id": "12455643-3cf1-4683-ad23-1cd32f7d5e0a",
  • "notification_event_condition_id": "70c7c5cb-dce2-4124-accb-870d39dbe852",
  • "notification_profile_id": "12455643-3cf1-4683-ad23-1cd32f7d5e0a",
  • "parameters": [
    • {
      • "name": "phone_number",
      • "value": "+13125550000"
      }
    ]
}
Response samples 
application/json
{
  • "data": {
    • "associated_record_type": "phone_number",
    • "associated_record_type_value": "+13125550000",
    • "created_at": "2019-10-15T10:07:15.527Z",
    • "id": "8eb5b5f9-5893-423c-9f15-b487713d44d4",
    • "notification_channel_id": "12455643-3cf1-4683-ad23-1cd32f7d5e0a",
    • "notification_event_condition_id": "70c7c5cb-dce2-4124-accb-870d39dbe852",
    • "notification_profile_id": "12455643-3cf1-4683-ad23-1cd32f7d5e0a",
    • "parameters": [
      • {
        • "name": "phone_number",
        • "value": "+13125550000"
        }
      ],
    • "status": "enable-received",
    • "updated_at": "2019-10-15T10:07:15.527Z"
    }
}
Delete a notification setting
Delete a notification setting.


SecuritybearerAuth 
Request 
path Parameters
id
required
string <uuid> 
Identifies the resource.


 
 Example:  6a09cdc3-8948-47f0-aa62-74ac943d6c58
Responses 
200
A Notification Setting response


Response Schema: application/json
object (NotificationSetting) 
 
associated_record_type
string
 
associated_record_type_value
string
 
created_at
string <date-time> 
ISO 8601 formatted date indicating when the resource was created.


 
id
string
A UUID.


 
notification_channel_id
string
A UUID reference to the associated Notification Channel.


 
notification_event_condition_id
string
A UUID reference to the associated Notification Event Condition.


 
notification_profile_id
string
A UUID reference to the associated Notification Profile.


 
Array of objects
 
status
string
Most preferences apply immediately; however, other may needs to propagate.


 Enum: "enabled" "enable-received" "enable-pending" "enable-submtited" "delete-received" "delete-pending" "delete-submitted" "deleted"  
updated_at
string <date-time> 
ISO 8601 formatted date indicating when the resource was updated.


 
201
A Notification Setting response - async


Response Schema: application/json
object (NotificationSetting) 
 
associated_record_type
string
 
associated_record_type_value
string
 
created_at
string <date-time> 
ISO 8601 formatted date indicating when the resource was created.


 
id
string
A UUID.


 
notification_channel_id
string
A UUID reference to the associated Notification Channel.


 
notification_event_condition_id
string
A UUID reference to the associated Notification Event Condition.


 
notification_profile_id
string
A UUID reference to the associated Notification Profile.


 
Array of objects
 
status
string
Most preferences apply immediately; however, other may needs to propagate.


 Enum: "enabled" "enable-received" "enable-pending" "enable-submtited" "delete-received" "delete-pending" "delete-submitted" "deleted"  
updated_at
string <date-time> 
ISO 8601 formatted date indicating when the resource was updated.


 
default
Unexpected error


Response Schema: application/json
Array of objects (Error) 
 
 Array 
code
required
string <int> 
 
detail
string
 
meta
object
 
object
 
title
required
string
 
delete/notification_settings/{id}
Request samples 
Response samples 
application/json
{
  • "data": {
    • "associated_record_type": "phone_number",
    • "associated_record_type_value": "+13125550000",
    • "created_at": "2019-10-15T10:07:15.527Z",
    • "id": "8eb5b5f9-5893-423c-9f15-b487713d44d4",
    • "notification_channel_id": "12455643-3cf1-4683-ad23-1cd32f7d5e0a",
    • "notification_event_condition_id": "70c7c5cb-dce2-4124-accb-870d39dbe852",
    • "notification_profile_id": "12455643-3cf1-4683-ad23-1cd32f7d5e0a",
    • "parameters": [
      • {
        • "name": "phone_number",
        • "value": "+13125550000"
        }
      ],
    • "status": "enable-received",
    • "updated_at": "2019-10-15T10:07:15.527Z"
    }
}
Retrieve a notification setting
Retrieve a notification setting.


SecuritybearerAuth 
Request 
path Parameters
id
required
string <uuid> 
Identifies the resource.


 
 Example:  6a09cdc3-8948-47f0-aa62-74ac943d6c58
Responses 
200
A Notification Setting response


Response Schema: application/json
object (NotificationSetting) 
 
associated_record_type
string
 
associated_record_type_value
string
 
created_at
string <date-time> 
ISO 8601 formatted date indicating when the resource was created.


 
id
string
A UUID.


 
notification_channel_id
string
A UUID reference to the associated Notification Channel.


 
notification_event_condition_id
string
A UUID reference to the associated Notification Event Condition.


 
notification_profile_id
string
A UUID reference to the associated Notification Profile.


 
Array of objects
 
status
string
Most preferences apply immediately; however, other may needs to propagate.


 Enum: "enabled" "enable-received" "enable-pending" "enable-submtited" "delete-received" "delete-pending" "delete-submitted" "deleted"  
updated_at
string <date-time> 
ISO 8601 formatted date indicating when the resource was updated.


 
default
Unexpected error


Response Schema: application/json
Array of objects (Error) 
 
 Array 
code
required
string <int> 
 
detail
string
 
meta
object
 
object
 
title
required
string
 
get/notification_settings/{id}
Request samples 
Response samples 
application/json
{
  • "data": {
    • "associated_record_type": "phone_number",
    • "associated_record_type_value": "+13125550000",
    • "created_at": "2019-10-15T10:07:15.527Z",
    • "id": "8eb5b5f9-5893-423c-9f15-b487713d44d4",
    • "notification_channel_id": "12455643-3cf1-4683-ad23-1cd32f7d5e0a",
    • "notification_event_condition_id": "70c7c5cb-dce2-4124-accb-870d39dbe852",
    • "notification_profile_id": "12455643-3cf1-4683-ad23-1cd32f7d5e0a",
    • "parameters": [
      • {
        • "name": "phone_number",
        • "value": "+13125550000"
        }
      ],
    • "status": "enable-received",
    • "updated_at": "2019-10-15T10:07:15.527Z"
    }
}