Rulesets
This table has one row per ruleset.
Column | Type | Definition | Sample Value(s) | Sample Use |
---|---|---|---|---|
APPLY_COMPLETED_STAGE_IN | Number | The amount of time in seconds after the sequence has completed before the 'completedStage' will be applied to the Prospect. | ||
AUTO_RESUME_OOTO_PROSPECTS | Boolean | A boolean value whether out-of-the-office Prospects will be automatically resumed. See 'autoResumeOotoProspectsIn' and 'autoResumeOotoProspectsExpiresIn' for more information | ||
AUTO_RESUME_OOTO_PROSPECTS_EXPIRES_IN | Number | The maximum amount of time in seconds to wait before opted-out Prospect will be resumed | ||
AUTO_RESUME_OOTO_PROSPECTS_IN | Number | The default amount of time in seconds to wait before opted-out Prospects will be resumed. | ||
BENTO | Varchar | A collection of machines that power the Outreach app. Orgs live inside these. | ||
BOUNCED_STAGE_ID | Varchar | The stage ID to assign to the prospect when a mailing in this sequence bounces. | ||
CALL_OPT_OUT_ACTION | Varchar | Determines if prospect can be added to sequences if they are opted out of calling. | ||
CALL_TASK_PRIORITY | Varchar | The task priority to use when creating call tasks based on mail opens | ||
CALL_TASK_PRIORITY_FROM_CLICKS | Varchar | The task priority to use when creating call tasks based on mail clicks. | ||
CLICKS_NEEDED_BEFORE_CALL_TASK_CREATED | Number | The number of email clicks needed before a call task will be automatically created. This feature will be disabled unless a value is set. | ||
COMPLETED_STAGE_ID | Varchar | The stage ID to assign to the prospect when this sequence completes. | ||
CREATED_AT | Timestamp_NTZ | The date and time the ruleset was created. | ||
DELIVERED_STAGE_ID | Varchar | The stage ID to assign to the prospect when a mailing in this sequence is delivered. | ||
DML_AT | Timestamp_NTZ | A datetime (local to server) in which the row was last modified. dml_at can be used to identify updated and new records, but as tables may not see changed records every day, it is not authoritative on when the table was last synced. | ||
DML_TYPE | Varchar | The type of manipulation that last occurred to a row. | ||
EMAIL_OPT_OUT_ACTION | Varchar | Determines if prospect can be added to sequences if they are opted out of emails. | ||
FINISHED_STAGE_ID | Varchar | The stage ID to assign to the prospect when this sequence finishes. | ||
ID | Varchar | Represents an individual row of data in a table. Fields in other tables that match to this ID will be called thisTable_id. e.g. ID in the calls table will appear as the call_id in another table. | ||
INCLUDE_UNSUBSCRIBE_LINKS | Boolean | A boolean value whether to include unsubscribe links within emails. | ||
IS_DELETED_IN_APP | Boolean | Is the latest dml_type "delete" or "backfill-delete". | ||
MEETING_BOOKED_ACTION | Varchar | Determines if a prospect is marked as finished when a meeting is booked. | ||
MINIMUM_PROSPECT_TOUCHED_INTERVAL | Number | 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 | Varchar | The name of the ruleset. | ||
O_ID | Varchar | Organization ID, also called instance ID. This is the ID for your unique Outreach account. | ||
OOTO_AUTO_EXTRACTION_ENABLED | Boolean | A boolean value determining whether to use out of the office return date auto extraction. | ||
OPENS_NEEDED_BEFORE_CALL_TASK_CREATED | Number | The number of email opens needed before a call task will be automatically created. This feature will be disabled unless a value is set. | ||
OPTED_OUT_STAGE_ID | Varchar | The stage ID to assign to the prospect when they opt out of this sequence. | ||
OWNER_ID | Varchar | The owner ID of the ruleset | ||
PERMIT_DUPLICATE_PROSPECTS | Varchar | 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. | ||
REPLIED_STAGE_ID | Varchar | The stage ID to assign to the prospect when a mailing in this sequence is replied to. | ||
SEQUENCE_EXCLUSIVITY | Varchar | 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. | ||
SMS_OPT_OUT_ACTION | Varchar | Determines if prospect can be added to sequences if they are opted out of SMS. | ||
SMS_RECEIVED_ACTION | Varchar | Determines if a prospect is marked as finished when a text message is received | ||
STARTED_STAGE_ID | Varchar | The stage ID to assign to the prospect when this sequence starts. | ||
STEP_OVERRIDES_ENABLED | Boolean | A boolean value determining whether to allow users to customize step templates when adding to sequence. | ||
SURROGATE_ID | Varchar | An md5 hash of bento, o_id and ID for a table. | This can be used to get distinct counts of records if an account has more than 1 org instance. Two orgs will both have a prospect with ID of "1" but each will have a different surrogate ID. | |
UPDATED_AT | Timestamp_NTZ | The UTC datetime for when this ruleset was updated. |