NtfcnChannelDef

Represents the messaging channels associated with the definition of a notification that’s configured for a specific object. For example, the Notification for Creation of Problems is a setup definition that applies to in-app and email notifications but eliminates Slack as a channel for notifying users. This object is available in API version 62.0 and later.

Supported SOAP API Calls

create(), delete(), describeSObjects(), query(), retrieve(), update()

Supported REST API Calls

DELETE, GET, HEAD, PATCH, POST, Query

Usage

Use this object to query and manage Notification Channel Definitions in your org. Client applications can create, update, delete, or query records associated with Notification Channel Definition via the API.

Fields

Active

Type: boolean
Properties: Create, Defaulted on create, Filter, Group, Sort, Update
Description: Indicates whether a notification for a specific channel type is active (true) or not (false).
Default value: false

ChannelType

Type: picklist
Properties: Create, Filter, Group, Restricted picklist, Sort, Update
Description: Specifies the type of channel for which a notification is defined.
Possible values:
- Email
- InApp—In-App
- Slack
- Teams

CreatedById

Type: reference
Properties: Create, Defaulted on create, Filter, Group, Sort
Description: The ID of the user who created this record.
Relationship Name: CreatedBy
Relationship Type: Lookup
Refers To: User

CreatedDate

Type: datetime
Properties: Create, Defaulted on create, Filter, Sort
Description: The date and time on which this record is created.

Id

Type: id
Properties: Defaulted on create, Filter, Group, Sort
Description: The ID of this Notification Channel Definition.

IsDeleted

Type: boolean
Properties: Defaulted on create, Filter, Group, Sort
Description: Indicates whether the notification channel definition is deleted or not.
Default value: false

LastModifiedById

Type: reference
Properties: Create, Defaulted on create, Filter, Group, Sort
Description: The ID of the user who last modified this record.
Relationship Name: LastModifiedBy
Relationship Type: Lookup
Refers To: User

LastModifiedDate

Type: datetime
Properties: Create, Defaulted on create, Filter, Sort
Description: The date and time on which this record was last modified.

ManageableState

Type: picklist
Properties: Filter, Group, Nillable, Restricted picklist, Sort
Description: Indicates the manageable state of the specified component that is contained in a package.
Possible values:
- beta—Managed-Beta
- deleted—Managed-Proposed-Deleted
- deprecated—Managed-Proposed-Deprecated
- deprecatedEditable—SecondGen-Installed-Deprecated
- installed—Managed-Installed
- installedEditable—SecondGen-Installed-Editable
- released—Managed-Released
- unmanaged—Unmanaged

NtfcnDefinitionId

Type: reference
Properties: Create, Filter, Group, Sort
Description: The notification definition for which a channel is specified. This field is a relationship field.
Relationship Name: NtfcnDefinition
Relationship Type: Lookup
Refers To: NtfcnDefinition

SystemModstamp

Type: datetime
Properties: Defaulted on create, Filter, Sort
Description: The date and time when this record was last modified by an automated process.