ActionableList

Represents an actionable list. This object is available in API version 57.0 and later.

Supported Calls

create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert()

Special Access Rules

Access to this object requires Industries Sales Excellence add-on and the Actionable Segmentation Permission Set License.

Fields

ActionableListDefinitionId

Type: reference
Properties: Create, Filter, Group, Nillable, Sort
Description: The list definition that's associated with the actionable list.
This field is a relationship field.
Relationship Name: ActionableListDefinition
Relationship Type: Lookup
Refers To: ActionableListDefinition

AssigneeId

Type: reference
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: The person to whom an actionable list is assigned.
This field is a polymorphic relationship field.
Relationship Name: Assignee
Relationship Type: Lookup
Refers To: Group, User

AssigneeType

Type: picklist
Properties: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update
Description: The type of assignee of an actionable list. Available in API version 58.0 and later.
Possible values:
- Queue
- RecordOwner
- User

AssignmentStatus

Type: picklist
Properties: Filter, Group, Nillable, Restricted picklist, Sort
Description: The status of the assignment done for an actionable list. Available in API version 58.0 and later.
Possible values:
- Failed
- InProgress
- PartiallyComplete
- Success
- Waiting

AutomaticAssigneeId

Type: reference
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: The assignee to whom the new members in an actionable list are automatically assigned. Available in API version 59.0 and later.
This field is a polymorphic relationship field.
Relationship Name: AutomaticAssignee
Relationship Type: Lookup
Refers To: Group, User

AutomaticAssigneeType

Type: picklist
Properties: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update
Description: Specifies the type of assignee to which the new members in an actionable list are automatically assigned. Available in API version 59.0 and later.
Possible values:
- Queue
- RecordOwner
- User

BatchCalcJobDefinitionId

Type: reference
Properties: Filter, Group, Nillable, Sort
Description: The batch calculation job definition associated with the actionable list. Available in API version 59.0 and later.
This field is a relationship field.
Relationship Name: BatchCalcJobDefinition
Relationship Type: Lookup
Refers To: BatchCalcJobDefinition

CompletionDate

Type: dateTime
Properties: Create, Filter, Nillable, Sort, Update
Description: The last date for completing engagement with the members in an actionable list. Available in API version 58.0 and later.

CurrencyIsoCode

Type: picklist
Properties: Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update
Description: The ISO currency code for the postauthorization request.
Available in API version 62.0 and later.
Default value: USD
Possible values:
- USD—U.S. Dollar

DefaultMemberStatusId

Type: reference
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: The default actionable list member status.
This field is a relationship field.
Relationship Name: DefaultMemberStatus
Relationship Type: Lookup
Refers To: ActionableListMemberStatus

DefaultSortMemberField

Type: string
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: The default field name used for sorting the actionable list members in Outreach List. Available in API version 58.0 and later.

Description

Type: string
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: The description about the actionable list.

IsActionableListConfigured

Type: boolean
Properties: Create, Defaulted on create, Filter, Group, Sort, Update
Description: Indicates if an actionable list is configured (true) or not (false).
Default value: false

IsAutoAssignmentAllowed

Type: boolean
Properties: Create, Defaulted on create, Filter, Group, Sort, Update
Description: Indicates whether automatic assignment of new actionable list members is allowed (true) or not (false).
Default value: false

IsSynchronizationAllowed

Type: boolean
Properties: Create, Defaulted on create, Filter, Group, Sort, Update
Description: Indicates whether an actionable list is refreshed (true) or not (false).
Available in API version 62.0 and later.
Default value: false

LastMemberAddDateTime

Type: string
Properties: Filter, Group, Nillable, Sort
Description: The date and time when the last member was added to an actionable list in epoch time format.

LastReferencedDate

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

LastViewedDate

Type: dateTime
Properties: Filter, Nillable, Sort
Description: The timestamp when the current user last viewed this record or list view.

ListStatus

Type: picklist
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: The status of the actionable list.
Possible values:
- Active
- Archived
- Draft
- Processing

MemberCount

Type: int
Properties: Filter, Group, Nillable, Sort
Description: The actionable list members count.

MemberCountLastModDtTime

Type: dateTime
Properties: Filter, Nillable, Sort
Description: The date and time when the member count of an actionable list was last modified.

MemberSortOrder

Type: picklist
Properties: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update
Description: The default sort order used for sorting the actionable list members in Outreach List.
Possible values:
- Ascending
- Descending

Name

Type: string
Properties: Create, Filter, Group, idLookup, Sort, Update
Description: The name of the actionable list.

ObjectName

Type: picklist
Properties: Create, Filter, Group, Restricted picklist, Sort, Update
Description: The object for which the actionable list is created.
Possible values are organized by the API version in which they were introduced. Values are available in all versions after introduction unless noted otherwise.

API version 60.0 and later:
PersonLifeEvent
API version 60.0 and later with Insurance Managed Package:
Possible values:
- Claim
- InsurancePolicy
- Quote
API version 59.0 and later with Health Cloud:
- CareFacilityBed
- CareRequest
- CareRequestItem
- CareServiceVisit
- CareServiceVisitPlan
- ClinicalServiceRequest
API version 59.0 and later with Loyalty Cloud:
- LoyaltyProgramMember
API version 59.0 and later:
- Case
API version 58.0 and later with Automotive Cloud:
- Vehicle
API version 58.0 and later:
- Asset
- Lead
- Opportunity
API version 57.0 and later:
- Account
- Contact

OmniScriptKey

Type: textarea
Properties: Create, Nillable, Update
Description: The key that's created by combining the type, subtype, and language of the OmniScript with a '/' separating these values.

OwnerId

Type: reference
Properties: Create, Defaulted on create, Filter, Group, Sort, Update
Description: The key that's created by combining the type, subtype, and language of the OmniScript with a '/' separating these values.
This field is a polymorphic relationship field.
Relationship Name: Owner
Relationship Type: Lookup
Refers To: Group, User

Priority

Type: picklist
Properties: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update
Description: The priority of an Actionable List.
Possible values:
- High
- Low
- Medium

SegmentIdentifier

Type: string
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: The ID of the segment on which an actionable list is created. Available in API version 62.0 and later.

SegmentMembershipTable

Type: string
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: The name of the segment membership history table that tracks the existing records in a segment and the records that were added or removed from the segment. Available in API version 62.0 and later.

SourceType

Type: picklist
Properties: Filter, Group, Nillable, Restricted picklist, Sort
Description: The source type of the actionable list.
Possible values:
- CrmAnalytics—Crm Analytics
- DataCloudPlatform—Data Cloud Platform

Status

Type: picklist
Properties: Filter, Group, Nillable, Restricted picklist, Sort
Description: The status of the actionable list.
Possible values:
- Failed
- Queued
- Success

SyncStartDateTime

Type: dateTime
Properties: Create, Filter, Nillable, Sort, Update
Description: The date and time when an actionable list started to synchronize with a Data Cloud segment. Available in API version 62.0 and later.

SynchronizationFailureCount

Type: int
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: The number of times an actionable list fails to synchronize with a Data Cloud segment. Available in API version 62.0 and later.

SynchronizationOperationType

Type: picklist
Properties: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update
Description: The type of operation that's performed when an actionable list synchronizes with a Data Cloud segment.
Available in API version 62.0 and later.
Possible values:
- Insert
- Update

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.

ActionableListChangeEvent: Change events are available for the object.
ActionableListFeed: Feed tracking is available for the object.
ActionableListHistory: History is available for tracked fields of the object.
ActionableListOwnerSharingRule: Sharing rules are available for the object.
ActionableListShare: Sharing is available for the object.

Industries Common Resources Developer Guide