Reminder Definition (POST, PATCH)

Configure a reminder by defining the reminder schedule type, such as recurring and non-recurring. Set rules and communication channels for a reminder to send the desired notifications to the users.

Resource

1/connect/reminder/reminder-definition

Resource example

1https://yourInstance.salesforce.com/services/data/v62.0/connect/reminder/reminder-definition

Available version

60.0

HTTP methods

POST, PATCH

Request body for POST

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
reminder​Channels	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

Response body for POST

Reminder Details

Request body for PATCH

JSON example

Here’s a sample input of a non-recurring reminder to update the reminder.

1{
2  "id": "17jSB00000000eLYAQ",
3  "name": "FirstReminder",
4  "parentRecordId": "0Kdxx0000004C92CAE",
5  "status": "Draft",
6  "schedule": {
7    "reminderType": "NonRecurring",
8    "firstReminderInterval": 1,
9    "secondReminderInterval": 5,
10    "thirdReminderInterval": 9,
11    "fourthReminderInterval": 13
12  },
13  "reminderChannels": [
14    {
15      "reminderDefinitionChannelId": "17kSB000000Y4dtYAC",
16      "channel": "Email",
17      "templateId": "00Xxx000000k1DvEAI",
18      "sendFrom": "john.doe@example.com",
19      "operationType": "Update"
20    }
21  ],
22  "rule": {
23    "criteriaLogic": "Or",
24    "criteria": [
25      {
26        "operator": "Equals",
27        "field": "Status",
28        "fieldType": "StaticEnum",
29        "value": "Completed"
30      },
31      {
32        "operator": "NotEquals",
33        "field": "Status",
34        "fieldType": "Integer",
35        "value": 7
36      }
37    ]
38  }
39}

Properties

Name	Type	Description	Required or Optional	Available Version
id	String	ID of the reminder definition.	Required	60.0

Response body for PATCH

Reminder Details