Parameters

Parameter Name	Value	Description

Parameter Name	Value	Description
title	String	Title of the notification
description	string	notification description
contents	string	notification contents
……	……	…….
……	……	…….
recurrence	Object	An object that holds dateRestrict parameters for defining the recurrence of notifications.

Recurrence Object:

Parameter Name	Value	Description

Parameter Name

Value

Description

fromDateTime

String

The start date and time for the recurrence are specified as the point when the announcement should be visible to their users.

Format: "yyyy-MM-dd HH:mm", using the 24-hour clock.

toDateTime

String

The end date and time for the recurrence should be specified as the point at which the announcement will no longer be visible to users.

Format: "yyyy-MM-dd HH:mm", using the 24-hour clock.

customRecurrence

Object

An object containing parameters for defining a custom recurrence. Any one of the dailyRecurrence, selectiveWeekRecurrence, or customWeekRecurrence can be chosen.

Custom Recurrence Object:

Parameter Name	Value	Description

Parameter Name	Value	Description
dailyRecurrence	Object	An object specifying daily recurrence parameters.
selectiveWeekRecurrence	Object	An object specifying selective week recurrence parameters.
customWeekRecurrence	Object	An object specifying custom week recurrence parameters.

Daily Recurrence Parameters

Parameter Name	Value	Description

Parameter Name	Value	Description
duration	Number	The duration of the recurrence, i.e. the number of days for which the notification should recur.
frequencyType	String	The frequency type of the dailyRecurrence, can be one of `"days"`, `"weeks"`, or `"months"`.

Selective Week Recurrence Parameters

Parameter Name	Value	Description

Parameter Name

Value

Description

recurrenceType

String

To specify the recurrence type, select either "weekly", "monthly", or "lastDayOfMonth".

recurrenceDay

String

If "weekly" is chosen, a specific day of the week must also be provided, such as "Monday".

If "monthly" is chosen, a specific day of the month must also be provided, such as "15".

Custom Week Recurrence Parameters

Parameter Name	Value	Description

Parameter Name	Value	Description

Parameter Name	Value	Description

Parameter Name

Value

Description

fromHours

String

The start time of the recurrence pattern indicates when the announcement should become visible to users.

Format: "HH:mm", using the 24-hour clock.

toHours

String

The end time of the recurrence pattern indicates when the announcement should no longer be visible to users.

Format: "HH:mm" with the 24-hour clock.

weekdays

Array of Strings

An array containing the weekdays on which the announcement should be visible to the user

Example:

["Monday", "Wednesday", "Friday"].

Example Postman Request:

POST Request

Set recurrence parameters

// Request Body:

[
    {
        "title":"Announcement from Rest API 1",
        "type":"dialog",
        "displayType":"0",
        "showButton":"true",
        "isActive":"true", 
        "format":"1",
        "recurrence": {
            "fromDateTime": "2024-02-21 08:00",
            "toDateTime": "2024-02-29 19:00",
            "runIndefinitely" : false,
            
            "customRecurrence" : {
                "dailyRecurrence": {
                    "frequencyType": "days",
                    "duration": 25
                }
            }
        }
    },
    {
        "title":"Announcement from Rest API 2",
        "description":"description 2",
        "contents":"Adding more fields soon",
        "type":"dialog",
        "displayType":"0",
        "showButton":"true",
        "isActive":"true", 
        "format":"1",
        "filterProjects" : true,
        "targetProject": ["TEST"],
        "recurrence": {
            "fromDateTime": "2024-03-10 09:00",
            "runIndefinitely" : true,
            
            "customRecurrence" : {
                "selectiveWeekRecurrence" : {
                    "recurrenceType": "weekly",
                    "recurrenceDay": "wednesday"
                }
            }
        }
    },
    {
        "title":"Announcement from Rest API 1",
        "type":"dialog",
        "displayType":"0",
        "showButton":"true",
        "isActive":"true", 
        "format":"1",
        "filterProjects" : true,
        "targetProject": ["TEST", "APP"],
        "recurrence": {
            "fromDateTime": "2024-12-03 08:00",
            "toDateTime": "2024-12-15 19:00",
            "runIndefinitely" : false,
            "customRecurrence" : {
                "selectiveWeekRecurrence" : {
                    "recurrenceType": "monthly"
                    "recurrenceDay": "15"
                }
            }
        }
    },
    {
        "title":"Announcement from Rest API 1",
        "type":"dialog",
        "displayType":"0",
        "showButton":"true",
        "isActive":"true", 
        "format":"1",
        "recurrence": {
            "fromDateTime": "2024-02-21 08:00",
            "toDateTime": "2024-02-29 19:00",
            "runIndefinitely" : false,
            "customRecurrence" : {
                "selectiveWeekRecurrence" : {
                    "recurrenceType": "lastDayOfMonth"
                }
            }
        }
    },
    {
        "title":"Announcement from Rest API 3",
        "description":"desc1",
        "contents":"Adding more fields soon",
        "type":"dialog",
        "displayType":"0",
        "showButton":"true",
        "isActive":"true", 
        "format":"1",
        "filterProjects" : true,
        "targetProject": ["TEST", "APP"],
        "recurrence": {
            "fromDateTime": "2024-05-02 10:00",
            "toDateTime": "2024-08-11 19:00",
            "runIndefinitely" : false,
            
            "customRecurrence" : {
                "customWeekRecurrence" : {
                    "fromHours" : "10:00",
                    "toHours" : "21:00",
                    "weekdays": ["monday", "wednesday", "friday"]
                }
            }
        }
    },
]

GET Request Example:

[
    {
        "date_restrict": "true",
        "num_anon": "null",
        "delay_button": "false",
        "display": "0",
        "format": "1",
        "show_button": "true",
        "active": "true",
        "description": "desc1",
        "total_anon_dwell": "null",
        "target_project": "null",
        "reset_button": "false",
        "title": "Announcement from Rest API 2",
        "type": "dialog",
        "temp_active": "false",
        "group_target": "null",
        "recurrence": {
            "fromDateTime": "2024-03-10 09:00",
            "customRecurrence": {
                "selectiveWeekRecurrence": {
                    "recurrenceDay": "wednesday",
                    "recurrenceType": "weekly"
                }
            },
            "toDateTime": "2024-04-12 10:00"
        },
        "filter_project": "false",
        "contents": "Adding more fields soon",
        "is_required": "false",
        "anonymous": "false",
        "button_text": "null",
        "id": "1",
        "filter_groups": "false"
    }
]

Announcer Series

Recurring notification configuration

Parameters

Parameters

Recurrence Object:

Custom Recurrence Object:

Example Postman Request: