Sign in
Notifications

Add a Notification Setting

Adds a notification setting that enables delivery of a notification event type to a notification profile.

post/notification_settings

Request body

associated_record_typestring
associated_record_type_valuestring
created_atstring date-time

ISO 8601 formatted date indicating when the resource was created.

idstring

A UUID.

notification_channel_idstring

A UUID reference to the associated Notification Channel.

notification_event_condition_idstring

A UUID reference to the associated Notification Event Condition.

notification_profile_idstring

A UUID reference to the associated Notification Profile.

status'enabled' | 'enable-received' | 'enable-pending' | 'enable-submtited' | 'delete-received' | 'delete-pending' | 'delete-submitted' | 'deleted'

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

updated_atstring date-time

ISO 8601 formatted date indicating when the resource was updated.

Example request

{
  "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"
}

Response

A Notification Setting response

Example response

{
  "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"
  }
}

Changes

Changed in 2 of the 61 revisions of this API.9

  • 1571b0380bd73See the full diff
    • ▲

      the errors/items/code response's property type/format changed from integer/int32 to string/ for status 400

      response-property-type-changed

    • ▲

      the errors/items/code response's property type/format changed from integer/int32 to string/ for status 422

      response-property-type-changed

    • ▲

      the errors/items/code response's property type/format changed from integer/int32 to string/ for status 500

      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 errors/items/code response's property type/format changed from string/ to integer/int32 for status 400

      response-property-type-changed

    • ▲

      the errors/items/code response's property type/format changed from string/ to integer/int32 for status 422

      response-property-type-changed

    • ▲

      the errors/items/code response's property type/format changed from string/ to integer/int32 for status 500

      response-property-type-changed

    • ▲

      the errors/items/source/pointer response's property type/format changed from string/json-pointer to string/ for status 400

      response-property-type-changed

    • ▲

      the errors/items/source/pointer response's property type/format changed from string/json-pointer to string/ for status 422

      response-property-type-changed

    • ▲

      the errors/items/source/pointer response's property type/format changed from string/json-pointer to string/ for status 500

      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