Email

POST

https://merchantapi.bill24.io/notification/v1/notificationmessage/send

Configuring Notification Channels (Email)

Before proceeding with the configuration, make sure you understand the fields that will change based on the notification channel (Email).

Request

Header Params

Body Params application/json

Example


[
  {
    "channels": [
      {
        "channel": "email",
        "to": "example@example.com",
        "metaData": {
          "retryOnFailure": true,
          "cc": "",
          "bcc": "",
          "attachments": "file url",
          "separateTo": false
        }
      }
    ],
    "subject": "OTP",
    "message": "Your code is 0092",
    "refId": "REF0092"
  }
]

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://merchantapi.bill24.io/notification/v1/notificationmessage/send' \
--header 'Authorization: "Bearer [token get from  Authorization]"' \
--header 'Content-Type:  "application/json"' \
--data-raw '[
  {
    "channels": [
      {
        "channel": "email",
        "to": "example@example.com",
        "metaData": {
          "retryOnFailure": true,
          "cc": "",
          "bcc": "",
          "attachments": "file url",
          "separateTo": false
        }
      }
    ],
    "subject": "OTP",
    "message": "Your code is 0092",
    "refId": "REF0092"
  }
]'

Responses

🟢200Success

application/json

Body

Example

{
    "code": "SUCCESS",
    "message": "Request success",
    "data": [
        {
            "notificationId": "3b65274a-17aa-45ab-9af3-e39432976c13",
            "status": 0,
            "exception": "",
            "channels": [
                {
                    "channel": "email",
                    "to": "example@example.com",
                    "metaData": {
                        "retryOnFailure": true,
                        "cc": "",
                        "bcc": "",
                        "attachments": "file url",
                        "separateTo": false
                    }
                }
            ],
            "subject": "OTP",
            "message": "Your code is 0092",
            "refId": "REF0092"
        }
    ]
}

🟠400Invalid input

🟠400Missing Field

Modified at 2025-03-10 11:38:09

Email

Configuring Notification Channels (Email)#

Request

Request samples

Responses

Configuring Notification Channels (Email)