Note: This release is in preview. Features described here don’t become generally available until the latest general availability date that Salesforce announces for this release. Before then, and where features are noted as beta, pilot, or developer preview, we can’t guarantee general availability within any particular time frame or at all. Make your purchase decisions only on the basis of generally available products and features.

Reminder Create Input

Input representation of a reminder definition to configure reminders along with the reminder channel.

JSON example

Here’s a sample to create non-recurring reminders.

1{
2  "name": "FirstReminder",
3  "parentRecordId": "0Kdxx0000004C92CAE",
4  "status": "Draft",
5  "schedule": {
6    "scheduleType": "NonRecurring",
7    "firstReminderInterval": 1,
8    "secondReminderInterval": 1,
9    "thirdReminderInterval": 1,
10    "fourthReminderInterval": 1
11  },
12  "reminderChannels": [
13    {
14      "channel": "Email",
15      "templateId": "00Xxx000000k1DvEAI",
16      "sendFrom": "john.doe@example.com"
17    }
18  ],
19  "rule": {
20    "criteriaLogic": "And",
21    "criteria": [
22      {
23        "operator": "Equals",
24        "field": "Status",
25        "fieldType": "StaticEnum",
26        "value": "Completed"
27      }
28    ]
29  }
30}

This example shows a sample to create recurring reminders.

1{
2  "name": "FirstReminder",
3  "parentRecordId": "0Kdxx0000004C92CAE",
4  "status": "Draft",
5  "schedule": {
6    "recurrenceRule": "RRULE:FREQ=DAILY;INTERVAL=1;UNTIL=20231130T000000Z;",
7    "scheduleType": "Recurring"
8  },
9  "reminderChannels": [
10    {
11      "channel": "Email",
12      "templateId": "00Xxx000000k1DvEAI",
13      "sendFrom": "john.doe@example.com"
14    }
15  ],
16  "rule": {
17    "criteriaLogic": "And",
18    "criteria": [
19      {
20        "operator": "Equals",
21        "field": "Status",
22        "fieldType": "StaticEnum",
23        "value": "Completed"
24      }
25    ]
26  }
27}

Properties

Name	Type	Description	Required or Optional	Available Version
`event`	String	Reserved for future use.	Optional	60.0
`name`	String	Name of the reminder definition.	Required	60.0
`parentEntity`	String	Reserved for future use.	Optional	60.0
`parentRecordId`	String	ID of the record for which the reminder is created.	Required	60.0
`reminderChannels`	Reminder Email Channel Input []	Communication channel that’s used to send the reminder.	Required	60.0
`rule`	Reminder Logical Operation Rule Input[]	Rule that’s used to configure the reminder.	Optional	60.0
`schedule`	Reminder Non-Recurrence Schedule Input Reminder Recurrence Schedule Input	Schedule that’s used to send the reminder.	Required	60.0
`status`	String	Status of the reminder definition. Valid values are: `Active`—The reminder is operational and is actively providing notifications based on the specified schedule or rule. `Draft`—The reminder is created but not activated. You can modify the reminder definition if the status is `Draft`. `Inactive`—The reminder is either deactivated or expired.	Required	60.0

Industries Common Resources Developer Guide

Reminder Create Input