Ruleset

A reusable set of behaviors to be applied to Sequences

applyCompletedStageIn
integer or null

The amount of time in seconds after the sequence has completed before the "completedStage" will be applied to the Prospect.

autoResumeOotoProspects
boolean or null

A boolean value whether out-of-the-office Prospects will be automatically resumed. See "autoResumeOotoProspectsIn" and "autoResumeOotoProspectsExpiresIn" for more information.

autoResumeOotoProspectsExpiresIn
integer or null

The maximum amount of time in seconds to wait before opted-out Prospect will be resumed.

autoResumeOotoProspectsIn
integer or null

The default amount of time in seconds to wait before opted-out Prospects will be resumed.

callOptOutAction
string or null <= 4 characters

Determines if prospect can be added to sequences if they are opted out of calling.

clicksNeededBeforeCallTaskCreated
integer or null

The number of email clicks needed before a call task will be automatically created. This feature will be disabled unless a value is set.

createdAt
string or null <date-time>

The date and time the ruleset was created.

emailOptOutAction
string or null <= 4 characters

Determines if prospect can be added to sequences if they are opted out of emails.

includeUnsubscribeLinks
boolean or null

A boolean value whether to include unsubscribe links within emails.

meetingBookedAction
string or null <= 255 characters

Determines if a prospect is marked as finished when a meeting is booked.

minimumProspectTouchedInterval
integer or null

The minimum number of seconds that must elapse between when a Prospect was last contacted and when they may be added to a sequnce. This feature will be disabled unless a value is set.

name
string or null <= 255 characters

The name of the ruleset.

ootoAutoExtractionEnabled
boolean or null

A boolean value determining whether to use out of the office return date auto extraction.

opensNeededBeforeCallTaskCreated
integer or null

The number of email opens needed before a call task will be automatically created. This feature will be disabled unless a value is set.

permitDuplicateProspects
string or null <= 255 characters

A value determining whether a Prospect may be added to this Sequence multiple times or not. Permitted values include "allow", "disallow" (the default) and "only_if_inactive", which indicates that Prospects may be re-added to this sequence if their existing SequenceState is inactive.

sequenceExclusivity
string or null <= 255 characters

A value determining whether Prospects may be added to multiple different Sequences. Permitted values include "all_sequences", "exclusive_sequences" and "none" (the default). If the value is "all_sequences", then Prospects may only be added if they are not active in any other Sequence; likewise, a Prospect active in a Sequence with "all_sequences" exclusivity cannot be added to any other Sequence. If the value is "exclusive_sequences", then Prospects may only be added if they are not active in any other Sequence with "exclusive_sequences" exclusivity; likewise, a Prospect active in a Sequence with "exclusive_sequences" exclusivity cannot be added to any other Sequence with "exclusive_sequences" exclusivity. If the value is "none", then no additional restrictions will be applied.

smsOptOutAction
string or null <= 4 characters

Determines if prospect can be added to sequences if they are opted out of SMS.

smsReceivedAction
string or null <= 255 characters

Determines if a prospect is marked as finished when a text message is received

stepOverridesEnabled
boolean or null

A boolean value determining whether to allow users to customize step templates when adding to sequence.

updatedAt
string or null <date-time>

The date and time the ruleset was last updated.

{
  • "applyCompletedStageIn": 0,
  • "autoResumeOotoProspects": true,
  • "autoResumeOotoProspectsExpiresIn": 0,
  • "autoResumeOotoProspectsIn": 0,
  • "callOptOutAction": "stri",
  • "clicksNeededBeforeCallTaskCreated": 0,
  • "createdAt": "2019-08-24T14:15:22Z",
  • "emailOptOutAction": "stri",
  • "includeUnsubscribeLinks": true,
  • "meetingBookedAction": "string",
  • "minimumProspectTouchedInterval": 0,
  • "name": "string",
  • "ootoAutoExtractionEnabled": true,
  • "opensNeededBeforeCallTaskCreated": 0,
  • "permitDuplicateProspects": "string",
  • "sequenceExclusivity": "string",
  • "smsOptOutAction": "stri",
  • "smsReceivedAction": "string",
  • "stepOverridesEnabled": true,
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Ruleset Relationships

object

The stage to assign to the prospect when a mailing in this sequence bounces. You can use only the attribute id to filter rulesets by bouncedStage (e.g. filter[bouncedStage][id]=X).

object

The task priority to use when creating call tasks based on mail opens. You can use only the attribute id to filter rulesets by callTaskPriorityFromOpens (e.g. filter[callTaskPriorityFromOpens][id]=X).

object

The task priority to use when creating call tasks based on mail clicks. You can use only the attribute id to filter rulesets by callTaskPriorityFromClicks (e.g. filter[callTaskPriorityFromClicks][id]=X).

object

The task priority to use when creating call tasks based on mail opens. You can use only the attribute id to filter rulesets by callTaskPriorityFromOpens (e.g. filter[callTaskPriorityFromOpens][id]=X).

object

The stage to assign to the prospect when this sequence completes. You can use only the attribute id to filter rulesets by completedStage (e.g. filter[completedStage][id]=X).

object

The stage to assign to the prospect when a mailing in this sequence is delivered. You can use only the attribute id to filter rulesets by deliveredStage (e.g. filter[deliveredStage][id]=X).

object

The stage to assign to the prospect when this sequence finishes. You can use only the attribute id to filter rulesets by finishedStage (e.g. filter[finishedStage][id]=X).

object

The stage to assign to the prospect when they opt out of this sequence. You can use only the attribute id to filter rulesets by optedOutStage (e.g. filter[optedOutStage][id]=X).

object

The owner of the ruleset. You can use only the attribute id to filter rulesets by owner (e.g. filter[owner][id]=X).

object

The stage to assign to the prospect when a mailing in this sequence is replied to. You can use only the attribute id to filter rulesets by repliedStage (e.g. filter[repliedStage][id]=X).

object

The sequences associated with this ruleset. You can use only the attribute id to filter rulesets by sequences (e.g. filter[sequences][id]=X).

object

The stage to assign to the prospect when this sequence starts. You can use only the attribute id to filter rulesets by startedStage (e.g. filter[startedStage][id]=X).

{
  • "bouncedStage": {},
  • "callTaskPriority": {},
  • "callTaskPriorityFromClicks": {},
  • "callTaskPriorityFromOpens": {},
  • "completedStage": {},
  • "deliveredStage": {},
  • "finishedStage": {},
  • "optedOutStage": {},
  • "owner": {},
  • "repliedStage": {},
  • "sequences": {},
  • "startedStage": {}
}

Ruleset Resource Metadata

METADATA NAME DESCRIPTION QUERY PARAM
canWrite A boolean value indicating whether the current API user has write access to this resource. provideAuthorizationMeta
canDelete A boolean value indicating whether the current API user has delete access to this resource. provideAuthorizationMeta

⌵ Ruleset Actions

Get a Collection of Rulesets

SecuritybearerAuth
Responses
200

OK

422

JSON error message

get/rulesets
Request samples
Response samples
application/vnd.api+json
{
  • "data": [
    ]
}

Create a New Ruleset

SecuritybearerAuth
Request
Request Body schema: application/vnd.api+json
required
object
Responses
201

Created

422

JSON error message

post/rulesets
Request samples
application/vnd.api+json
{
  • "data": {
    }
}
Response samples
application/vnd.api+json
{
  • "data": {
    }
}

Delete an Existing Ruleset by ID

SecuritybearerAuth
Request
path Parameters
id
required
integer
Responses
204

Deleted

422

JSON error message

delete/rulesets/{id}
Request samples
Response samples
application/vnd.api+json
{
  • "errors": [
    ]
}

Get a Ruleset by ID

SecuritybearerAuth
Request
path Parameters
id
required
integer
Responses
200

OK

404

Not Found

get/rulesets/{id}
Request samples
Response samples
application/vnd.api+json
{
  • "data": {
    }
}

Update a Ruleset

SecuritybearerAuth
Request
path Parameters
id
required
integer
Request Body schema: application/vnd.api+json
required
object
Responses
200

OK

422

JSON error message

patch/rulesets/{id}
Request samples
application/vnd.api+json
{
  • "data": {
    }
}
Response samples
application/vnd.api+json
{
  • "data": {
    }
}