Reminder

Merchant can schedule reminder for Business process.

When you want to create a single or multiple occurence of reminders, this is your action.

Union (required)

Context (required)

NameTypeDescriptionRules
datesarraySpecific dates in timestamps for which reminders will be published.
Examples: [9029230234,2304923049234].
fromStartarraySequnces of days for which reminder will trigger in respect of start date. Example will be read like this - 1 day later from start date, 3 day later from start date and so on.
Examples: ["1d","3d","35d"].
fromExpirationarraySquences of days from Expiry date. It will readable in reverse order. Like 1 day before expiry , 3 day before expiry and so on.
Examples: ["1d","3d","35d"].
avoidDaysOfWeekarrayDays of week those should be avoided for reminder.
Examples: ["FRIDAY","SATURDAY"].
Possible values: MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY, SUNDAY.
avoidDatesarrayDates those should be avoided for reminder.
Examples: ["2024-12-12T12:12:12Z"].
sendTimestring(required) Day time in UTC when reminder will be pushed. It should be in the format HH:mm:ss (24-hour clock).
Examples: "12:00:00".
Pattern: ^([01]\d

Example

Below is an example payload for adding an Reminder action to a business process or blueprint.

{
    "type": "reminder",
    "union": 1,
    "context": {
        "dates": [
            9029230234,
            2304923049234
        ],
        "fromStart": [
            "1d",
            "3d",
            "35d"
        ],
        "fromExpiration": [
            "1d",
            "3d",
            "35d"
        ],
        "avoidDaysOfWeek": [
            "FRIDAY",
            "SATURDAY"
        ],
        "avoidDates": [
            "2024-12-12T12:12:12Z"
        ],
        "sendTime": "12:00:00"
    }
}