High Velocity Sales Actions

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

Supported REST HTTP Methods

URIs

Assign Target To Sales Cadence:

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

Remove Target From Sales Cadence:

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

Pause Sales Cadence Tracker:

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

Resume Sales Cadence Tracker:

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

Change Sales Cadence Target Assignee:

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

Modify Cadence Tracker Attributes:

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

Send Sales Cadence Event:

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

Select Template For Sales 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 Sales Cadence

Available in API version 45.0.

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

Sample Input

The following code sample adds a target to a sales cadence:

1{
2  "inputs" : [ {
3    "salesCadenceNameOrId" : "77Cxx0000004CXEEA2",
4    "targetId" : "00Qxx000002TRI2EAO"
5    }] 
6}

Remove Target From Sales Cadence

Available in API version 45.0.

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

Sample Input

The following code sample removes a target from a sales cadence:

1{
2  "inputs" : [ {
3    "completionReasonCode" : "ManuallyRemoved",
4    "targetId" : "00Qxx000002TRI2EAO"
5    }]
6}

Pause Sales Cadence Tracker

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

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

Sample Input

The following code sample pauses a target in its sales cadence:

1{
2  "inputs" : [ {
3    "targetId" : "00Qxx000002TRI2EAO"
4    }]
5}

Resume Sales Cadence Tracker

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

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

Sample Input

The following code sample resumes a target in its sales cadence:

1{
2  "inputs" : [ {
3    "targetId" : "00Qxx000002TRI2EAO"
4    }]
5}

Change Sales Cadence Target Assignee

Available in API version 50.0.

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

Sample Input

The following code changes a target’s assignee:

1{
2  "inputs" : [ {
3    "targetId" : "00Qxx000002TRI2EAO",
4    "userId" : "005R0000000eg3zIAA",
5    }] 
6}

Modify Cadence Tracker Attributes

Available in API version 51.0.

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

Sample Input

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

1{
2  "inputs" : [ {
3    "actionCadenceTrackerId" : "0qBR00000005CXvMAM",
4    "completionDisposition" : "Customer Engaged",
5    "relatedToId" : "006R0000003DNpJIAW",
6    "relatedToAttributionType" : "Activation"
7    }] 
8}

Send Sales Cadence Event

Available in API version 52.0.

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

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

Sample Input

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

1{
2  "inputs" : [ {
3    "recordId" : "8HFR00000005WyqOAE",
4    "eventType" : "Manual Complete"
5    }] 
6}

Select Template For Sales Cadence Step Tracker

Retrieve the email template or call script from a sales cadence step or sales 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

Sample Input

The following code retrieves the email template or call script for two sales cadence steps:

1{"inputs": [ {
2        "stepTrackerId" : "8HFR00000006LE8OAM"
3    },
4    {
5        "stepTrackerId" : "8HFR00000006LEDOA2"
6    }]
7}

Sample Output

The following code sample illustrates a response after one success and one failure.

1[ {
2  "actionName" : "selectTemplateForSalesCadenceStepTracker",
3  "errors" : null,
4  "isSuccess" : true,
5  "outputValues" : {
6    "output" : {
7      "SplitPercentage" : 10.0,
8      "TemplateId" : "00XR0000000UOtZMAW"
9    }
10  }
11}, {
12  "actionName" : "selectTemplateForSalesCadenceStepTracker",
13  "errors" : [ {
14    "statusCode" : "UNKNOWN_EXCEPTION",
15    "message" : "No template was found.",
16    "fields" : [ ]
17  } ],
18  "isSuccess" : false,
19  "outputValues" : {
20    "error" : "No template was found."
21  }
22} ]

Error Response Types

High Velocity Sales 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 Sales Cadence action.

1[ {
2         "actionName" : "assignTargetToSalesCadence",
3         "isSuccess" : true
4         } ]

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

1[ {
2         "actionName" : "assignTargetToSalesCadence",
3         "errors" : [ {
4         "statusCode" : "UNKNOWN_EXCEPTION",
5         "message" : "The object needs to be a valid sales cadence entity.",
6         "fields" : [ ]
7         } ],
8         "isSuccess" : false,
9         "outputValues" : {
10         "error" : "The object needs to be a valid sales cadence entity."
11         }
12         } ]