Skip to main content

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

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.

default: Unexpected error

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
  • ]

Loading...