ReminderDefinition

Represents information about the condition, rule, and related configuration that’s set for a reminder. This object is available in API version 60.0 and later.

Supported Calls

describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve()

Fields

Condition

Type: textarea
Properties: Nillable
Description: The condition that’s used to schedule the reminder.

EndDateTime

Type: dateTime
Properties: Filter, Nillable, Sort
Description: The date until when the reminder will be sent.

FirstReminderInterval

Type: int
Properties: Filter, Group, Nillable, Sort
Description: The number of days after which the first reminder is sent.

FourthReminderInterval

Type: int
Properties: Filter, Group, Nillable, Sort
Description: The number of days after which the fourth reminder should be sent.

LastReferencedDate

Type: dateTime
Properties: Filter, Nillable, Sort
Description: The timestamp when the current user last accessed this record indirectly, for example, through a list view or related record.

LastViewedDate

Type: dateTime
Properties: Filter, Nillable, Sort
Description: The timestamp when the current user last viewed this record or list view. If this value is null, and LastReferenceDate field isn’t null, the user accessed this record or list view indirectly.

MaximumRecurrenceCount

Type: int
Properties: Filter, Group, Nillable, Sort
Description: The maximum number of times the reminder will be sent.

Name

Type: string
Properties: Filter, Group, idLookup, Sort
Description: The name of the reminder definition.

OccurrenceType

Type: picklist
Properties: Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort
Description: The occurrence of the reminder for an event.

This field is available in API version 61.0 and later.
Default value: PostEvent
Possible values:
- PostEvent
- PreEvent

OwnerId

Type: reference
Properties: Filter, Group, Sort
Description: ID of the owner of this object.

This field is a polymorphic relationship field.
Relationship Name: Owner
Relationship Type: Lookup
Refers To: Group, User

RecurrenceRule

Type: string
Properties: Filter, Group, Nillable, Sort
Description: The recurrence rule that’s used for the schedule if the reminder is recurring type.

RelatedObjectName

Type: string
Properties: Filter, Group, Nillable, Sort
Description: The name of the object for which the reminder definition is created. This field is available in API version 61.0 and later.

RelatedRecordId

Type: reference
Properties: Filter, Group, Nillable, Sort
Description: The record for which the reminder definition is being defined.

This field is a relationship field.
Relationship Name: RelatedRecord
Relationship Type: Lookup
Refers To: Survey

SecondReminderInterval

Type: int
Properties: Filter, Group, Nillable, Sort
Description: The number of days after which the second reminder should be sent.

Status

Type: picklist
Properties: Defaulted on create, Filter, Group, Restricted picklist, Sort
Description: Specifies the status of the reminder.
Default value: Draft
Possible values:
- Active
- Draft
- Inactive

ThirdReminderInterval

Type: int
Properties: Filter, Group, Nillable, Sort
Description: The number of days after which the third reminder should be sent.

Type

Type: picklist
Properties: Defaulted on create, Filter, Group, Restricted picklist, Sort
Description: Specifies the type of the reminder.
Default value: Recurring
Possible values:
- Nonrecurring
- Recurring

Associated Objects

This object has the following associated objects. If the API version isn’t specified, they’re available in the same API versions as this object. Otherwise, they’re available in the specified API version and later.

ReminderDefinitionHistory: History is available for tracked fields of the object.
ReminderDefinitionOwnerSharingRule: Sharing rules are available for the object.
ReminderDefinitionShare: Sharing is available for the object.