Create a broadcast

Creates a new broadcast. When a broadcast is created, it generates individual notifications for relevant users.

post

Header parameters

Brand-URLstringRequired

The brand URL of the request. This is used to identify the brand.

Example: YOUR_BRAND_URL

Auth-KeystringRequired

This is used to authenticate the request. If the request is not authenticated, the server will return a 401 Unauthorized response.

Example: YOUR_AUTH_KEY

Body

application/jsontext/jsonapplication/*+json

typestring · enumRequiredPossible values:

channelstring · enumRequiredPossible values:

titlestring · min: 1Required

The main title of the notification. Displayed prominently to the user.

contentstring · min: 1Required

The main message or body of the notification.

actionURLstring · uri | nullableOptional

The action url. Deep link URL for action buttons.

categorystring | nullableOptional

A general grouping or category label for notifications, useful for organizing and filtering.

topicstring | nullableOptional

A more specific sub-label or theme related to the notification, such as a campaign name or feature tag.

scheduledDatestring · date-time | nullableOptional

The date and time at which the notification should be sent. If null, it will be sent immediately.

Responses

200

The request was successful.

application/json

401

The user is not authorized to access the requested resource. The request is missing the required Auth-Key header.

application/json

429

API call exceeded rate limit due to too many requests.

application/json

post

HTTPcURLJavaScriptPython

POST /api/v1/notifications HTTP/1.1
Host: protocol.jframework.io
Brand-URL: text
Auth-Key: text
Content-Type: application/json
Accept: */*
Content-Length: 304

{
  "type": "0 - Segment",
  "channel": "0 - Unknown",
  "title": "text",
  "content": "text",
  "actionURL": "https://example.com",
  "category": "text",
  "topic": "text",
  "metadata": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  },
  "scheduledDate": "2025-09-13T00:28:32.353Z",
  "conditions": [
    {
      "field": "text",
      "operator": "0 - Equal",
      "value": "text"
    }
  ]
}

application/jsontext/jsonapplication/*+json

{
  "success": true,
  "statusCode": 200,
  "message": "The request was successful.",
  "data": {
    "id": "sApKpllz4sAplsmzha",
    "title": "Title",
    "type": "Segment",
    "channel": "InApp",
    "content": "Content",
    "actionURL": "https://example.com/action",
    "category": "Category",
    "topic": "Topic",
    "sentTime": "2025-09-12T15:18:49.7083+07:00",
    "seenAt": "2025-09-12T15:18:49.7083+07:00",
    "metadata": null,
    "scheduledDate": null,
    "status": "ReadEmailNotification",
    "testMode": true
  },
  "errors": []
}