Newer Version Available

This content describes an older version of this product. View Latest

ActionCadence

Represents the definition of a sales cadence. This object is available in API version 45.0 and later.
Use ActionCadence and its related objects to learn about a sales cadence, including:
  • The current state of the sales cadence.
  • The steps that the sales cadence contains.
  • Which leads, contacts, or person accounts are assigned to the sales cadence.

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

By learning when the sales cadence objects are created and deleted, you can make the most of the sales cadence API.
  • An ActionCadence record is created when you use the High Velocity Sales app to create a sales 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 a sales cadence.
  • An ActionCadenceStepTracker record is created each time the prospect moves to a new step.

All of these sales cadence records exist until you use the High Velocity Sales app to delete a sales cadence. If many prospects have been assigned to the sales cadence, there can be many associated ActionCadenceTracker and ActionCadenceStepTracker records. In this case, deleting the sales cadence can take some time. While the sales cadence is being deleted, the ActionCadence record is in the Deleting state.

Supported Calls

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

Fields

Field Details
ActivatedDate
Type
date
Properties
Filter, Group, Nillable, Sort
Description
The date that the user activated the sales cadence. ActionCadence objects are created in a draft state and must be manually activated before they are used.
Description
Type
textarea
Properties
Nillable, Update
Description
The description of this sales cadence.
ErrorMessage
Type
string
Properties
Filter, Group, Nillable, Sort
Description
If there was an error when activating the sales cadence, this field contains the error message.
LastReferencedDate
Type
dateTime
Properties
Filter, Nillable, Sort
Description
The date this object was last referenced.
LastViewedDate
Type
dateTime
Properties
Filter, Nillable, Sort
Description
The date this sales cadence was last viewed in the High Velocity Sales app.
Name
Type
string
Properties
Filter, Group, idLookup, Sort, Update
Description
The name of this sales cadence. Every sales cadence in an org must have a unique name.
OwnerId
Type
reference
Properties
Filter, Group, Sort, Update
Description
The ID of the owner of the sales cadence (typically the user who created it).

To change the owner of a sales cadence, the new owner must have read access to sales cadences enabled in their user profile.

Note

State
Type
picklist
Properties
Filter, Group, Nillable, Restricted picklist, Sort, Update
Description
This entity's state.
Possible values are:
  • Active

    The user finished modifying the sales cadence and has activated it. At this point, you can't make any more changes to the steps in the sales cadence.

  • Deleting

    All records associated with this sales cadence, including the ActionCadence record and all its related records, are being deleted. While in this state, the ActionCadence cannot be attached to a prospect.

  • Draft

    ActionCadence objects are in the draft state when they are created. In this state, the ActionCadence cannot be assigned to any prospect.

  • Error

    An error occurred while trying to activate the sales cadence.

Usage

Use ActionCadence to learn how many sales cadences are currently active:
1select COUNT() from ActionCadence where State="Active"
Retrieve all ActionCadence records that have "West Coast" in their name:
1SELECT ActionCadenceId FROM ActionCadence WHERE NAME LIKE '[West Coast Cadence]%'
Retrieve all ActionCadence records owned by a specific user:
1SELECT ActionCadenceId  FROM ActionCadence WHERE OwnerId = '<owner id>'