notification-types

Create Notification Type

post/v1/notification-types

Request

  • Base URL: https://api.elaan.io (the document declares no server; this is the origin it was published from)
  • URL: https://api.elaan.io/v1/notification-types
  • Auth: none declared

Headers

authorizationstring nullable

Request body

keystring required
channel_defaultsobject
variablesstring[]
allows_opt_outboolean

Whether contacts may override this type's channel defaults. Set false for transactional notifications a recipient must not be able to switch off (email verification, password reset). This does NOT force delivery on every channel — channel_defaults still decides which channels fire; only the contact's veto is removed.

Example request

{
  "key": "order_shipped",
  "channel_defaults": {
    "email": true
  },
  "variables": [
    "first_name",
    "order_id"
  ],
  "allows_opt_out": true
}

Response

Successful Response

keystring required
channel_defaultsobject required
variablesstring[] required
allows_opt_outboolean required
is_deletedboolean required

Changes

No recorded changes to this operation across all 1 revision of this API.