ActionCadence

Represents the definition of a cadence.

Use ActionCadence and its related objects to learn about an action cadence, including:

  • The current state of the action cadence.
  • The steps that the action cadence contains.
  • Which leads, contacts, or person accounts are assigned to the action cadence.

The ActionCadence, ActionCadenceStep, ActionCadenceRule, and ActionCadenceRuleCondition objects define an action cadence and the steps that it contains. ActionCadenceTracker and ActionCadenceStepTracker track a prospect’s movement through an active action cadence.

By learning when the action cadence objects are created and deleted, you can make the most of the action cadence API.

  • An ActionCadence record is created when you use the Sales Engagement app to create a cadence.
  • An ActionCadenceStep record is created to represent a step. If the step is a branch step, then corresponding ActionCadenceRule and ActionCadenceRuleCondition records are also created.
  • An ActionCadenceTracker record is created when you assign a prospect to an action cadence.
  • An ActionCadenceStepTracker record is created each time the prospect moves to a new step.

All of these action cadence records exist until you use the Sales Engagement app to delete an action cadence. If many prospects have been assigned to the action cadence, there can be many associated ActionCadenceTracker and ActionCadenceStepTracker records. In this case, deleting the action cadence can take some time. While the action cadence is being deleted, the value for the State field is Deleting on the ActionCadence record.

Introduced in API version 45.0.

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

  • Type: date
  • Properties: Filter, Group, Nillable, Sort
  • Description: The date that the user activated the action cadence. ActionCadence objects are created in a draft state and must be manually activated before they’re used.
  • Type: int
  • Properties: Filter, Group, Nillable, Sort
  • Introduced: API version 57.0
  • Description: The total number of active targets that are currently assigned with this cadence.
  • Type: textarea
  • Properties: Create, Nillable, Update
  • Description: The description of this action cadence.
  • Type: string
  • Properties: Filter, Group, Nillable, Sort
  • Description: If there was an error when activating the action cadence, this field contains the error message.

  • Type: reference

  • Properties: Create, Filter, Group, Sort, Update

  • Introduced: API version 49.0

  • Description:

    The ID of the folder that contains the action cadence.

    This is a polymorphic relationship field.

  • Relationship name: Folder

  • Relationship type: polymorphic

  • Refers to: Folder, Organization, User

  • Type: string
  • Properties: Filter, Nillable, Sort
  • Introduced: API version 49.0
  • Description: The name of the folder that contains the action cadence.

  • Type: boolean

  • Properties: Defaulted on create, Filter, Group, Sort

  • Introduced: API version 55.0

  • Description:

    Whether the cadence is allowed to have a wait step before a daisy chain step (true) or not (false).

    The default value is false.

  • Default value: false

  • Type: datetime
  • Properties: Filter, Nillable, Sort
  • Introduced: API version 53.0
  • Description: The date and time this object was last edited.
  • Type: string
  • Properties: Create, Filter, Group, idLookup, Sort, Update
  • Description: The name of this action cadence. Every action cadence in an org must have a unique name.
  • Type: picklist
  • Properties: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update
  • Description: This entity’s state.
  • Possible values:
    • Active — Active
    • Deleting — Deleting
    • Draft — Draft
    • Error — Error
    • Inactive — Inactive
  • Type: int
  • Properties: Filter, Group, Nillable, Sort
  • Introduced: API version 57.0
  • Description: The total number of successful dispositions this cadence has upon completion. For example, customer engaged or customer connected.
  • Type: int
  • Properties: Filter, Group, Nillable, Sort
  • Introduced: API version 57.0
  • Description: The number of total steps associated with this cadence. This value doesn’t include special step types such as root, branch, and daisy chain.
  • Type: int
  • Properties: Filter, Group, Nillable, Sort
  • Introduced: API version 57.0
  • Description: The total number of targets that have been assigned with this cadence.
  • Type: picklist
  • Properties: Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update
  • Introduced: API version 56.0
  • Description: Indicates the type of ActionCadence.
  • Possible values:
    • Standard — Standard
    • Quick — Quick
    • SDR — SDR

Use ActionCadence to learn how many action cadences are currently active:

Retrieve all ActionCadence records that have “West Coast” in their name:

Retrieve all ActionCadence records owned by a specific user:

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.