The name or ID of the cadence step where the target starts in the cadence.
targetId
ID
Required. The ID of the contact, a lead, or person account to add to the cadence.
userId
ID
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
ID
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:
Required if actionCadenceTrackerId is null. The ID of the contact, a lead, or person account to remove from the cadence.
actionCadenceTrackerId
ID
Required if targetId is null. The ID of the action cadence tracker to remove from the cadence.
completionReasonCode
string
Required. The completion reason code indicates how the target competed the cadence. The only valid value is ManuallyRemoved.
completionDisposition
string
The disposition of the completed cadence tracker. Valid values are: Success, Customer Engaged, Customer Connected, Contact Later, No Response, Not Interested, Disqualified, Bad Data, or Duplicate.
relatedToId
ID
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
string
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), or Collected (valid for invoices).
shouldApplyUserContext
boolean
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:
Required. The ID of the cadence tracker to modify.
completionDisposition
string
The disposition of the completed cadence tracker. Valid values are: Success, Customer Engaged, Customer Connected, Contact Later, No Response, Not Interested, Disqualified, Bad Data, or Duplicate.
relatedToId
ID
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
string
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), or 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”:
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.
j