# Preview notification

Preview notification recipients and get build ID for sending

Endpoint: POST /api/notification/v1/orgs/{platform_key}/notification-builder/preview/
Version: 3.59.0-ai-plus
Security: PlatformApiKeyAuthentication

## Path parameters:

  - `platform_key` (string, required)

## Request fields (application/json):

  - `template_id` (string,null)
    Use a predefined template in the system

  - `template_data` (object,null)
    Specify this to send a new custom message without using a predefined template

  - `template_data.message_title` (string,null)
    Title of the message

  - `template_data.message_body` (string, required)
    This would be the body of the message. Some context are available to use in the system.

    e.g

  - `channels` (array, required)
    Specify the channel ids to send notifications to.

  - `sources` (array, required)
    Specify the sources to send notifications to

  - `sources.type` (string, required)
    *  - email
*  - username
*  - platform
*  - csv
*  - department
*  - pathway
*  - program
    Enum: "email", "username", "platform", "csv", "department", "pathway", "program"

  - `sources.data` (any,null, required)

  - `context` (object)
    Specify the context that would be available in the message text

  - `process_on` (string,null)
    (ISO datetime) Specify the date and time of processing this notification. Note, notifications are sent hourly and only scheduled messages prior to the beginning of the hour would be sent

## Response 200 fields (application/json):

  - `status` (string, required)

  - `build_id` (string, required)

  - `count` (integer, required)

  - `warning` (string,null, required)

  - `recipients` (array, required)

  - `recipients.username` (string, required)

  - `recipients.email` (string, required)

## Response 400 fields (application/json):

  - `status` (string, required)

  - `message` (string, required)

  - `details` (any)

## Response 404 fields (application/json):

  - `status` (string, required)

  - `message` (string, required)

  - `details` (any)

## Response 500 fields (application/json):

  - `status` (string, required)

  - `message` (string, required)

  - `details` (any)