Sales Engagement Actions | Actions Developer Guide

Sales Engagement must be set up in your org. The user must have permissions to use cadences.

Supported REST HTTP Methods

URIs: Assign Target To Cadence:; /services/data/vXX.X/actions/standard/assignTargetToSalesCadence; Remove Target From Cadence:; /services/data/vXX.X/actions/standard/removeTargetFromSalesCadence; Pause Cadence Tracker:; /services/data/vXX.X/actions/standard/pauseSalesCadenceTracker; Resume Cadence Tracker:; /services/data/vXX.X/actions/standard/resumeSalesCadenceTracker; Change Cadence Target Assignee:; /services/data/vXX.X/actions/standard/changeSalesCadenceTargetAssignee; Modify Cadence Tracker Attributes:; /services/data/vXX.X/actions/standard/modifyCadenceTrackerAttributes; Send Cadence Event:; /services/data/vXX.X/actions/standard/sendSalesCadenceEvent; Select Template For Cadence Step Tracker:; /services/data/vXX.X/actions/standard/selectTemplateForSalesCadenceStepTracker
Formats: JSON, XML
HTTP Methods: GET, HEAD, POST
Authentication: Authorization: Bearer token
Other Information: Error Response Types

Assign Target to Cadence

Available in API version 45.0.

URI: /services/data/vXX.X/actions/standard/assignTargetToSalesCadence

Table 1. Inputs
Input	Details
salesCadenceNameOrId	Type string Description Required. The name or ID of the cadence.
startStepNameOrId	Type string Description The name or ID of the cadence step where the target starts in the cadence.
targetId	Type ID Description Required. The ID of the contact, a lead, or person account to add to the cadence.
userId	Type ID Description The ID of the user designated as the target assignee. The target assignee is the sales rep who performs the cadence steps for the target.
relatedToId	Type ID Description The ID of the target’s related opportunity or invoice. This field is only available when Relate Opportunities to Cadences or Use Cadences for Collections is turned on in Sales Engagement Setup.

Sample Input: The following code sample adds a target to a cadence:

Remove Target from Cadence

Available in API version 45.0.

URI: /services/data/vXX.X/actions/standard/removeTargetFromSalesCadence

Table 2. Inputs
Input	Details
targetId	Type ID Description Required if actionCadenceTrackerId is null. The ID of the contact, a lead, or person account to remove from the cadence.
actionCadenceTrackerId	Type ID Description Required if targetId is null. The ID of the action cadence tracker to remove from the cadence.
completionReasonCode	Type string Description Required. The completion reason code indicates how the target competed the cadence. Valid value is: ManuallyRemoved
completionDisposition	Type string Description The disposition of the completed cadence tracker. Valid values are: Success Customer Engaged Customer Connected Contact Later No Response Not Interested Disqualified Bad Data Duplicate
relatedToId	Type ID Description The ID of the target’s related opportunity or invoice. This field is only available when Relate Opportunities to Cadences or Use Cadences for Collections is turned on in Sales Engagement Setup.
relatedToAttributionType	Type string Description The attribution type of the target’s related opportunity or invoice. This field is only available when Relate Opportunities to Cadences or Use Cadences for Collections is turned on in Sales Engagement Setup. Valid values are: Activation (Valid for both opportunities and invoices.) Maturation (Valid for opportunities.) Collected (Valid for invoices.)
shouldApplyUserContext	Type boolean Description Indicates whether to remove only action cadence trackers owned by the running user (`true`) or not (`false`).

Sample Input: The following code sample removes a target from a cadence:

Pause Cadence Tracker

Pause a target in its cadence. Available in API version 50.0.

URI: /services/data/vXX.X/actions/standard/pauseSalesCadenceTracker

Table 3. Inputs
Input	Details
targetId	Type ID Description Required. The ID of the contact, a lead, or person account to pause.
resumeTime	Type String Description Optional. The scheduled end time for the pause.

Sample Input: The following code sample pauses a target in its cadence:

Resume Cadence Tracker

Resume a target in its cadence. Available in API version 50.0.

URI: /services/data/vXX.X/actions/standard/resumeSalesCadenceTracker

Table 4. Inputs
Input	Details
targetId	Type ID Description Required. The ID of the contact, a lead, or person account to pause.

Sample Input: The following code sample resumes a target in its cadence:

Change Cadence Target Assignee

Available in API version 50.0.

URI: /services/data/vXX.X/actions/standard/changeSalesCadenceTargetAssignee

Table 5. Inputs
Input	Details
targetId	Type ID Description Required. The ID of the contact, a lead, or person account to pause.
userId	Type ID Description The ID of the user designated as the target assignee. The target assignee is the sales rep who performs the cadence steps for the target.

Sample Input: The following code changes a target’s assignee:

Modify Cadence Tracker Attributes

Available in API version 51.0.

URI: /services/data/vXX.X/actions/standard/modifyCadenceTrackerAttributes

Table 6. Inputs
Input	Details
actionCadenceTrackerId	Type ID Description Required. The ID of the cadence tracker to modify.
completionDisposition	Type string Description The disposition of the completed cadence tracker. Valid values are: Success Customer Engaged Customer Connected Contact Later No Response Not Interested Disqualified Bad Data Duplicate
relatedToId	Type ID Description The ID of the target’s related opportunity or invoice. This field is only available when Relate Opportunities to Cadences or Use Cadences for Collections is turned on in Sales Engagement Setup.
relatedToAttributionType	Type string Description The attribution type of the target’s related opportunity or invoice. This field is only available when Relate Opportunities to Cadences or Use Cadences for Collections is turned on in Sales Engagement Setup. Valid values are: Activation (Valid for both opportunities and invoices.) Maturation (Valid for opportunities.) Collected (Valid for invoices.)

Sample Input: The following code modifies a cadence tracker with a Completion Disposition of “Customer Engaged”, a related opportunity, and an Attribution Type of “Activation”:

Send Cadence Event

Available in API version 52.0.

Send an event to a cadence, such as skipping or manually completing a step.

URI: /services/data/vXX.X/actions/standard/sendSalesCadenceEvent

Table 7. Inputs
Input	Details
recordId	Type ID Description Required. The ID of the cadence step tracker to send the event to.
eventType	Type string Description Required. The type of event to send. Valid values are: Skip Manual Complete

Sample Input: The following code sends a Manual Complete event to a cadence step tracker:

Select Template for Cadence Step Tracker

Retrieve the email template or call script from a cadence step or cadence step variant (if variant testing) to be used while executing a step for a particular target. Available in API version 53.0.

URI: /services/data/vXX.X/actions/standard/selectTemplateForSalesCadenceStepTracker

Table 8. Inputs
Input	Details
stepTrackerId	Type ID Description Required. The ID of the cadence step tracker.

Table 9. Outputs
Output	Details
output	Type JSON Description The email template or call script ID and its related split percentage.
error	Type string Description The error message returned when the action fails.

Sample Input: The following code retrieves the email template or call script for two cadence steps:
Sample Output: The following code sample illustrates a response after one success and one failure.

Error Response Types

Sales Engagement actions can respond with success or errors.

If any type of error occurs with an action, the isSuccess field is false.

This example illustrates a success response for the Assign Target To Cadence action.

This example illustrates an error caused by sending invalid input values to the Assign Target To Cadence action.