Email

Request

Header Params

Authorization

string

required

Do not include square [] brackets in the request

Example:

"Bearer [token get from Authorization]"

Content-Type

string

required

Example:

"application/json"

Body Params application/json

array of:

channels

array [object {3}]

required

List of communication channels.

channel

string

required

Communication method (e.g.,"email").

to

string

required

Recipient's contact information (e.g.,email).

metaData

object

required

Additional settings such as retry policies.

subject

string

required

Subject of the notification.

message

string

required

The message content to be sent.

refId

string

required

Unique reference ID for the notification.

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

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

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

code

string

required

Status of the request (e.g., "SUCCESS").

message

string

required

Additional information about the request.

data

array [object {7}]

required

Details of the notification request.

notificationId

string

required

Unique identifier for the notification.

status

integer

required

Status of the notification (e.g., 0 for success).

exception

string

required

Any exceptions encountered (if applicable).

channels

array [object {3}]

required

Details about the communication channel.

subject

string

required

The subject of the notification.

message

string

required

The notification message content.

refId

string

required

Reference ID for the notification.

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

Configuring Notification Channels (Email)#

Request

Request samples

Responses

Configuring Notification Channels (Email)