Industries Common Resources Developer Guide

Clouds with binary code floating aboveCloud with binary code floating above

No Results

Search Tips:

  • Please consider misspellings
  • Try different search keywords
Industries Common Resources
AI Accelerator and Scoring Framework
Action Launcher
Actionable List Members
Actionable Segmentation
Business Rules Engine
Collections and Recovery
Context Service
Criteria-Based Search and Filter
Data Processing Engine, Batch Management, and Monitor Workflow Services
Digital Lending
Discovery Framework
Decision Explainer
Einstein Relationship Insights
Einstein Standard Invocable Actions
Engagement
Group Membership and Households
Identity Verification
Intelligent Document Reader
Intelligent Form Reader
Interest Tagging
Omnistudio Business APIs
Outcome Management Developer Guide
Outreach List
Process Compliance Navigator
Record Alerts
Record Rollup Definitions
Scheduled Reminders
Scheduled Reminders Standard Objects
Scheduled Reminders Business APIs
REST Reference
Resources
Request Bodies
Reminder Create Input
Reminder Update Input
Reminder Email Channel Input
Reminder Logical Operation Rule Input
Reminder Boolean Criteria Input
Reminder Date Criteria Input
Reminder Decimal Criteria Input
Reminder Integer Criteria Input
Reminder Text Criteria Input
Reminder Nonrecurring Schedule Input
Reminder Recurring Schedule Input
Response Bodies
Sentiment Insights
Service Process Studio
Timeline
Virtual Calls
Associated Objects
IndustriesSettings
Industries Object Access by Community License
Access Industries Features Deployed Using Managed Packages
PDF

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.
{
  "name": "FirstReminder",
  "parentRecordId": "0Kdxx0000004C92CAE",
  "status": "Draft",
  "schedule": {
    "scheduleType": "NonRecurring",
    "firstReminderInterval": 1,
    "secondReminderInterval": 1,
    "thirdReminderInterval": 1,
    "fourthReminderInterval": 1
  },
  "reminderChannels": [
    {
      "channel": "Email",
      "templateId": "00Xxx000000k1DvEAI",
      "sendFrom": "john.doe@example.com"
    }
  ],
  "rule": {
    "criteriaLogic": "And",
    "criteria": [
      {
        "operator": "Equals",
        "field": "Status",
        "fieldType": "StaticEnum",
        "value": "Completed"
      }
    ]
  }
}
This example shows a sample to create recurring reminders.
{
  "name": "FirstReminder",
  "parentRecordId": "0Kdxx0000004C92CAE",
  "status": "Draft",
  "schedule": {
    "recurrenceRule": "RRULE:FREQ=DAILY;INTERVAL=1;UNTIL=20231130T000000Z;",
    "scheduleType": "Recurring"
  },
  "reminderChannels": [
    {
      "channel": "Email",
      "templateId": "00Xxx000000k1DvEAI",
      "sendFrom": "john.doe@example.com"
    }
  ],
  "rule": {
    "criteriaLogic": "And",
    "criteria": [
      {
        "operator": "Equals",
        "field": "Status",
        "fieldType": "StaticEnum",
        "value": "Completed"
      }
    ]
  }
}
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