Get a notification setting

GET 
/notification_settings/:id

Get a notification setting.

Request

Path Parameters

id uuidrequired

The id of the resource.

Responses

200: A Notification Setting response

application/json

• Schema
• Example (from schema)

Schema

data

NotificationSetting

id string

A UUID.

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.

associated_record_type string

associated_record_type_value string

status string

Possible values: [enabled, enable-received, enable-pending, enable-submtited, delete-received, delete-pending, delete-submitted, deleted]

Most preferences apply immediately; however, other may needs to propagate.

notification_channel_id string

A UUID reference to the associated Notification Channel.

parameters

object[]

Array [

name string

value string

]

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.

{
  "data": {
    "id": "8eb5b5f9-5893-423c-9f15-b487713d44d4",
    "notification_event_condition_id": "70c7c5cb-dce2-4124-accb-870d39dbe852",
    "notification_profile_id": "12455643-3cf1-4683-ad23-1cd32f7d5e0a",
    "associated_record_type": "phone_number",
    "associated_record_type_value": "+13125550000",
    "status": "enable-received",
    "notification_channel_id": "12455643-3cf1-4683-ad23-1cd32f7d5e0a",
    "parameters": [
      {
        "name": "phone_number",
        "value": "+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...