HubSpot: Sequences schemas

← Sequences operations · All schemas

Create sequence — request body — body

Field	Type	Presence	Description and constraints
$	object	Root
dependencies	array	Required within parent	An array of dependencies between sequence steps, each defined by the PublicSequenceStepDependencyRequest schema.
dependencies[]	Model	Each item	Expand Create sequence — request body — body dependencies item
dynamic	boolean	Required within parent	A boolean indicating whether the sequence is dynamic.
engagementTriggers	Model	Optional	Expand Create sequence — request body — body engagement Triggers
folderId	string	Optional	The identifier of the folder where the sequence is stored. It is a string.
name	string	Required within parent	The name of the sequence. It is a string.
settings	Model	Required within parent	Expand Create sequence — request body — body settings
steps	array	Required within parent	An array of steps in the sequence, each defined by the PublicSequenceStepRequest schema.
steps[]	Model	Each item	Expand Create sequence — request body — body steps item

Referenced models: Create sequence — request body — body engagement Triggers, Create sequence — request body — body settings, Create sequence — request body — body dependencies item, Create sequence — request body — body steps item

Create sequence — request body — body dependencies item

Field	Type	Presence	Description and constraints
$	object	Root
branchNumber	integer	Required within parent	An integer indicating the branch number associated with the dependency. Format: int32
dependencyType	string	Required within parent	A string indicating the type of dependency. Valid values include 'TASK_COMPLETION' and 'MANUAL_PAUSE'. One of: ADAPTIVE_COMPLETION, MANUAL_PAUSE, TASK_COMPLETION
reliesOnStepOrder	integer	Required within parent	An integer representing the order of the step that is relied upon by another step. Format: int32
requiredByStepOrder	integer	Required within parent	An integer representing the order of the step that requires the dependency. Format: int32

Create sequence — request body — body engagement Triggers

Field	Type	Presence	Description and constraints
$	object	Root
numberOfClicks	integer	Optional	An integer representing the number of times links within an email must be clicked to trigger an engagement action. Format: int32
numberOfOpens	integer	Optional	An integer representing the number of times an email must be opened to trigger an engagement action. Format: int32

Create sequence — request body — body settings

Field	Type	Presence	Description and constraints
$	object	Root
eligibleFollowUpDays	string	Required within parent	Specifies the days on which follow-ups are eligible to be sent. Valid values include 'EVERYDAY', 'BUSINESS_DAYS', and 'WEEKDAYS_ONLY'. One of: BUSINESS_DAYS, EVERYDAY, WEEKDAYS_ONLY
individualTaskRemindersEnabled	boolean	Required within parent	A boolean indicating whether individual task reminders are enabled.
sellingStrategy	string	Required within parent	Defines the selling strategy to be used. Valid values include 'LEAD_BASED' and 'ACCOUNT_BASED'. One of: ACCOUNT_BASED, LEAD_BASED
sendWindowEndMinute	integer	Required within parent	An integer representing the end minute of the window during which emails can be sent. Format: int32
sendWindowStartMinute	integer	Required within parent	An integer representing the start minute of the window during which emails can be sent. Format: int32
taskCreationMinute	integer	Required within parent	An integer indicating the minute at which tasks should be created. Format: int32
taskReminderMinute	integer	Required within parent	An integer indicating the minute at which task reminders should be sent. Format: int32
unenrollmentSettings	Model	Required within parent	Expand Create sequence — request body — body settings unenrollment Settings
useThreadedFollowUps	boolean	Required within parent	A boolean indicating whether follow-ups should be threaded.

Referenced models: Create sequence — request body — body settings unenrollment Settings

Create sequence — request body — body settings unenrollment Settings

Field	Type	Presence	Description and constraints
$	object	Root
emailSettings	Model	Required within parent	Expand Create sequence — request body — body settings unenrollment Settings email Settings
meetingSettings	Model	Required within parent	Expand Create sequence — request body — body settings unenrollment Settings meeting Settings

Referenced models: Create sequence — request body — body settings unenrollment Settings email Settings, Create sequence — request body — body settings unenrollment Settings meeting Settings

Create sequence — request body — body settings unenrollment Settings email Settings

Field	Type	Presence	Description and constraints
$	object	Root
criteria	string	Required within parent	A string representing the criteria for email settings. Valid values include 'ALL' and 'NONE'. One of: ALL, NONE
sellingStrategy	string	Required within parent	A string indicating the selling strategy for email settings. Valid values are 'LEAD_BASED' and 'ACCOUNT_BASED'. One of: ACCOUNT_BASED, LEAD_BASED

Create sequence — request body — body settings unenrollment Settings meeting Settings

Field	Type	Presence	Description and constraints
$	object	Root
criteria	string	Required within parent	Specifies the criteria for meetings, with valid values being 'ALL' or 'NONE'. One of: ALL, NONE
sellingStrategy	string	Required within parent	Indicates the selling strategy employed, which can be either 'LEAD_BASED' or 'ACCOUNT_BASED'. One of: ACCOUNT_BASED, LEAD_BASED

Create sequence — request body — body steps item

Field	Type	Presence	Description and constraints
$	object	Root
actionType	string	Required within parent	A string indicating the type of action to be performed in this step. Valid values include 'EMAIL', 'TASK', and 'FINISH_ENROLLMENT'. One of: ADAPTIVE_CONTAINER, EMAIL, FINISH_ENROLLMENT, TASK
branchNumber	integer	Required within parent	An integer representing the branch number of this step, used for branching logic in sequences. Format: int32
delayMillis	integer	Required within parent	An integer representing the delay in milliseconds before this step is executed. Format: int64
delayMillisMax	integer	Optional	An integer specifying the maximum delay in milliseconds for this step. Format: int64
delayMillisMin	integer	Optional	An integer specifying the minimum delay in milliseconds for this step. Format: int64
dynamic	boolean	Required within parent	A boolean indicating whether the step is dynamic, allowing for conditional execution based on certain criteria.
emailPattern	Model	Optional	Expand Create sequence — request body — body steps item email Pattern
stepOrder	integer	Required within parent	An integer indicating the order of the step within the sequence. Format: int32
taskPattern	Model	Optional	Expand Create sequence — request body — body steps item task Pattern
variants	array	Required within parent	An array of PublicSequenceStepVariantRequest objects, each representing a variant of this step.
variants[]	Model	Each item	Expand Create sequence — request body — body steps item variants item

Referenced models: Create sequence — request body — body steps item email Pattern, Create sequence — request body — body steps item variants item, Create sequence — request body — body steps item task Pattern

Create sequence — request body — body steps item email Pattern

Field	Type	Presence	Description and constraints
$	object	Root
templateId	string	Required within parent	The unique identifier for the email template to be used. It is a string and is required.
threadEmailToStepOrder	integer	Optional	An integer indicating the step order to which the email should be threaded. This property is optional. Format: int32

Create sequence — request body — body steps item task Pattern

Field	Type	Presence	Description and constraints
$	object	Root
notes	string	Optional	A string containing additional notes or details about the task.
queueId	string	Optional	A string identifier for the queue to which the task belongs.
subject	string	Optional	A string representing the subject of the task.
taskPriority	string	Required within parent	The priority level of the task. Valid values include 'NONE', 'HIGH', 'MEDIUM', and 'LOW'. One of: HIGH, LOW, MEDIUM, NONE
taskType	string	Required within parent	The type of task to be performed. Valid values include 'CALL', 'MEETING', 'EMAIL', 'TODO', 'LINKED_IN_CONNECT', and 'LINKED_IN_MESSAGE'. One of: CALL, EMAIL, LINKED_IN_CONNECT, LINKED_IN_MESSAGE, MEETING, TODO
templateId	string	Optional	A string identifier for the template associated with the task.
threadEmailToStepOrder	integer	Optional	An integer representing the order of the step to which the email should be threaded. Format: int32

Create sequence — request body — body steps item variants item

Field	Type	Presence	Description and constraints
$	object	Root
activated	boolean	Required within parent	A boolean indicating whether this variant is active.
emailPattern	Model	Optional	Expand Create sequence — request body — body steps item email Pattern
taskPattern	Model	Optional	Expand Create sequence — request body — body steps item task Pattern
variantOrdinal	integer	Required within parent	An integer indicating the order of this variant among other variants of the same step. Format: int32

Referenced models: Create sequence — request body — body steps item email Pattern, Create sequence — request body — body steps item task Pattern

Create sequence — response body

Field	Type	Presence	Description and constraints
$	object	Root
sequence	Model	Required within parent	Expand Update sequence — response body
userView	Model	Optional	Expand Create sequence — response body — user View

Referenced models: Create sequence — response body — user View, Update sequence — response body

Create sequence — response body — user View

Field	Type	Presence	Description and constraints
$	object	Root
email	string	Optional	The email address of the user. It is a string.
firstName	string	Optional	The first name of the user. It is a string.
lastName	string	Optional	The last name of the user. It is a string.

Enroll a contact — request body — body

Field	Type	Presence	Description and constraints
$	object	Root
contactId	string	Required within parent	The unique identifier of the contact to be enrolled in the sequence. It is a string.
senderAliasAddress	string	Optional	An optional alias email address that can be used as the sender's address. It is a string.
senderEmail	string	Required within parent	The email address of the sender responsible for the sequence enrollment. It is a string.
sequenceId	string	Required within parent	The unique identifier of the sequence in which the contact is to be enrolled. It is a string.

Enroll a contact — response body

Field	Type	Presence	Description and constraints
$	object	Root
enrolledAt	string	Required within parent	The date and time when the contact was enrolled in the sequence, in ISO 8601 format. Format: date-time
id	string	Required within parent	The unique identifier for the sequence enrollment.
toEmail	string	Required within parent	The email address of the contact who is enrolled in the sequence.
updatedAt	string	Required within parent	The date and time when the sequence enrollment was last updated, in ISO 8601 format. Format: date-time

List sequences — sequences list — response body

Field	Type	Presence	Description and constraints
$	object	Root
paging	Model	Optional	Expand List sequences — sequences list — response body — paging
results	array	Required within parent	An array of sequence objects, each represented by a PublicSequenceLiteResponse.
results[]	Model	Each item	Expand List sequences — sequences list — response body — results item
total	JSON	Required within parent
total (anyOf 1)	integer	Alternative	The total number of sequences available. It is an integer value. Format: int32
total (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Referenced models: List sequences — sequences list — response body — results item, List sequences — sequences list — response body — paging

List sequences — sequences list — response body — paging

Field	Type	Presence	Description and constraints
$	object	Root	Represents the pagination information for navigating through a list of results in the API. It provides details on how to access the previous or next set of results.
next	Model	Optional	Expand Search for calls — response body — paging next
prev	Model	Optional	Expand Search for meetings — response body — paging prev

Referenced models: Search for calls — response body — paging next, Search for meetings — response body — paging prev

List sequences — sequences list — response body — results item

Field	Type	Presence	Description and constraints
$	object	Root
createdAt	string	Required within parent	The date and time when the sequence was created, in ISO 8601 format. Format: date-time
folderId	string	Optional	The identifier of the folder containing the sequence, represented as a string.
id	string	Required within parent	The unique identifier for the sequence, represented as a string.
name	string	Required within parent	The name of the sequence, represented as a string.
updatedAt	string	Required within parent	The date and time when the sequence was last updated, in ISO 8601 format. Format: date-time
userId	string	Required within parent	The unique identifier of the user associated with the sequence, represented as a string.

Retrieve enrollment details — response body

Field	Type	Presence	Description and constraints
$	object	Root
enrolledAt	string	Required within parent	The date and time when the contact was enrolled in the sequence, in ISO 8601 format. Format: date-time
enrolledBy	string	Required within parent	The unique identifier of the user who enrolled the contact in the sequence.
enrolledByEmail	string	Required within parent	The email address of the user who enrolled the contact in the sequence.
id	string	Required within parent	The unique identifier for the sequence enrollment.
sequenceId	string	Required within parent	The unique identifier of the sequence in which the contact is enrolled.
sequenceName	string	Required within parent	The name of the sequence in which the contact is enrolled.
toEmail	string	Required within parent	The email address of the contact enrolled in the sequence.
updatedAt	string	Required within parent	The date and time when the sequence enrollment was last updated, in ISO 8601 format. Format: date-time

Retrieve performance — response body

Field	Type	Presence	Description and constraints
$	object	Root
companyMetrics	Model	Optional	Expand Retrieve performance — response body — company Metrics
sequenceId	string	Required within parent	The unique identifier for the sequence, represented as a string.
statusByStep	array	Required within parent	An array of objects detailing the enrollment status for each step in the sequence, including the count and current step order.
statusByStep[]	Model	Each item	Expand Retrieve performance — response body — status By Step item
steps	array	Required within parent	An array of objects, each representing the performance metrics for individual steps within the sequence.
steps[]	Model	Each item	Expand Retrieve performance — response body — steps item
summary	Model	Required within parent	Expand Retrieve performance — response body — summary
timeline	array	Required within parent	An array of objects representing points in time with specific performance metrics, such as enrollments and meetings booked.
timeline[]	Model	Each item	Expand Retrieve performance — response body — timeline item

Referenced models: Retrieve performance — response body — company Metrics, Retrieve performance — response body — status By Step item, Retrieve performance — response body — summary, Retrieve performance — response body — steps item, Retrieve performance — response body — timeline item

Retrieve performance — response body — company Metrics

Field	Type	Presence	Description and constraints
$	object	Root
companiesEngaged	JSON	Required within parent
companiesEngaged (anyOf 1)	integer	Alternative	The number of companies that have engaged with the sequence. An integer in int64 format. Format: int64
companiesEngaged (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
companiesEnrolled	JSON	Required within parent
companiesEnrolled (anyOf 1)	integer	Alternative	The number of companies that have been enrolled in the sequence. An integer in int64 format. Format: int64
companiesEnrolled (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
companiesScheduledMeeting	JSON	Required within parent
companiesScheduledMeeting (anyOf 1)	integer	Alternative	The number of companies that have scheduled a meeting as a result of the sequence. An integer in int64 format. Format: int64
companiesScheduledMeeting (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
contactsEnrolledWithCompanyId	JSON	Required within parent
contactsEnrolledWithCompanyId (anyOf 1)	integer	Alternative	The number of contacts enrolled in the sequence that are associated with a company ID. An integer in int64 format. Format: int64
contactsEnrolledWithCompanyId (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Retrieve performance — response body — status By Step item

Field	Type	Presence	Description and constraints
$	object	Root
count	JSON	Required within parent
count (anyOf 1)	integer	Alternative	An integer in int64 format representing the number of enrollments at the current step. Format: int64
count (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
currentStepOrder	JSON	Required within parent
currentStepOrder (anyOf 1)	integer	Alternative	An integer indicating the order of the current step in the sequence. Format: int32
currentStepOrder (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
enrollmentStatus	string	Required within parent	A string representing the status of the enrollment at the current step.

Retrieve performance — response body — steps item

Field	Type	Presence	Description and constraints
$	object	Root
calls	JSON	Required within parent
calls (anyOf 1)	integer	Alternative	An integer (int64) representing the number of calls made in this step. Format: int64
calls (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
callsConnected	JSON	Required within parent
callsConnected (anyOf 1)	integer	Alternative	An integer (int64) indicating the number of calls that were successfully connected in this step. Format: int64
callsConnected (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
clicked	JSON	Required within parent
clicked (anyOf 1)	integer	Alternative	An integer (int64) showing the number of times links in emails from this step have been clicked. Format: int64
clicked (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
executionCount	JSON	Required within parent
executionCount (anyOf 1)	integer	Alternative	An integer (int64) indicating the number of times this step has been executed. Format: int64
executionCount (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
meetingsBooked	JSON	Required within parent
meetingsBooked (anyOf 1)	integer	Alternative	An integer (int64) representing the number of meetings booked as a result of this step. Format: int64
meetingsBooked (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
onTimeTaskCompletionCount	JSON	Required within parent
onTimeTaskCompletionCount (anyOf 1)	integer	Alternative	An integer (int64) representing the number of tasks completed on time in this step. Format: int64
onTimeTaskCompletionCount (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
onTimeTaskCompletionSum	JSON	Required within parent
onTimeTaskCompletionSum (anyOf 1)	integer	Alternative	An integer (int64) indicating the sum of on-time task completions for this step. Format: int64
onTimeTaskCompletionSum (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
opened	JSON	Required within parent
opened (anyOf 1)	integer	Alternative	An integer (int64) indicating how many times emails from this step have been opened. Format: int64
opened (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
personalizationRateAvg	JSON	Optional
personalizationRateAvg (anyOf 1)	number	Alternative	A number representing the average personalization rate for this step.
personalizationRateAvg (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
personalizationRateCount	JSON	Required within parent
personalizationRateCount (anyOf 1)	integer	Alternative	An integer (int64) indicating the count of personalized actions in this step. Format: int64
personalizationRateCount (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
replied	JSON	Required within parent
replied (anyOf 1)	integer	Alternative	An integer (int64) representing the number of replies received from emails sent in this step. Format: int64
replied (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
stepKey	string	Required within parent	A string that uniquely identifies the step.
stepOrder	JSON	Required within parent
stepOrder (anyOf 1)	integer	Alternative	An integer representing the order of the step within the sequence. Format: int32
stepOrder (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
tasksCompleted	JSON	Required within parent
tasksCompleted (anyOf 1)	integer	Alternative	An integer (int64) indicating the number of tasks completed in this step. Format: int64
tasksCompleted (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Retrieve performance — response body — summary

Field	Type	Presence	Description and constraints
$	object	Root
associatedDeals	JSON	Optional
associatedDeals (anyOf 1)	integer	Alternative	The number of deals associated with the sequence. Represented as an integer in int64 format. Format: int64
associatedDeals (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
bounced	JSON	Required within parent
bounced (anyOf 1)	integer	Alternative	The number of emails in the sequence that bounced. Represented as an integer in int64 format. Format: int64
bounced (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
clicked	JSON	Required within parent
clicked (anyOf 1)	integer	Alternative	The number of times links in the sequence emails have been clicked. Represented as an integer in int64 format. Format: int64
clicked (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
contacts	JSON	Required within parent
contacts (anyOf 1)	integer	Alternative	The total number of contacts associated with the sequence. Represented as an integer in int64 format. Format: int64
contacts (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
dealsClosed	JSON	Optional
dealsClosed (anyOf 1)	integer	Alternative	The number of deals closed as a result of the sequence. Represented as an integer in int64 format. Format: int64
dealsClosed (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
engaged	JSON	Required within parent
engaged (anyOf 1)	integer	Alternative	The number of contacts who engaged with the sequence. Represented as an integer in int64 format. Format: int64
engaged (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
enrolled	JSON	Required within parent
enrolled (anyOf 1)	integer	Alternative	The number of contacts enrolled in the sequence. Represented as an integer in int64 format. Format: int64
enrolled (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
meetingsBooked	JSON	Required within parent
meetingsBooked (anyOf 1)	integer	Alternative	The number of meetings booked as a result of the sequence. Represented as an integer in int64 format. Format: int64
meetingsBooked (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
noResponse	JSON	Required within parent
noResponse (anyOf 1)	integer	Alternative	The number of contacts who did not respond to the sequence. Represented as an integer in int64 format. Format: int64
noResponse (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
opened	JSON	Required within parent
opened (anyOf 1)	integer	Alternative	The number of times emails in the sequence have been opened. Represented as an integer in int64 format. Format: int64
opened (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
replied	JSON	Required within parent
replied (anyOf 1)	integer	Alternative	The number of replies received from emails in the sequence. Represented as an integer in int64 format. Format: int64
replied (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
totalRevenue	JSON	Optional
totalRevenue (anyOf 1)	number	Alternative	The total revenue generated from the sequence. Represented as a number.
totalRevenue (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
unsubscribed	JSON	Required within parent
unsubscribed (anyOf 1)	integer	Alternative	The number of contacts who unsubscribed from the sequence. Represented as an integer in int64 format. Format: int64
unsubscribed (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Retrieve performance — response body — timeline item

Field	Type	Presence	Description and constraints
$	object	Root
enrolledAt	JSON	Required within parent
enrolledAt (anyOf 1)	integer	Alternative	The time at which the enrollment occurred, represented as a Unix timestamp in milliseconds. Format: int64
enrolledAt (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
enrollments	JSON	Required within parent
enrollments (anyOf 1)	integer	Alternative	The total number of enrollments recorded at this point in the sequence timeline. Represented as an integer. Format: int64
enrollments (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
meetingsBooked	JSON	Required within parent
meetingsBooked (anyOf 1)	integer	Alternative	The number of meetings booked at this point in the sequence timeline. Represented as an integer. Format: int64
meetingsBooked (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Retrieve sequence — sequences get By Sequence Id — response body

Field	Type	Presence	Description and constraints
$	object	Root
createdAt	string	Required within parent	The date and time when the sequence was created, in ISO 8601 format. Format: date-time
dependencies	array	Required within parent	An array of dependencies between sequence steps, each represented by a PublicSequenceStepDependencyResponse object.
dependencies[]	Model	Each item	Expand Update sequence — response body — dependencies item
folderId	string	Optional	The unique identifier for the folder containing the sequence.
id	string	Required within parent	The unique identifier for the sequence.
name	string	Required within parent	The name of the sequence.
settings	Model	Optional	Expand Update sequence — response body — settings
steps	array	Required within parent	An array of steps included in the sequence, each represented by a PublicSequenceStepResponse object.
steps[]	Model	Each item	Expand Retrieve sequence — sequences get By Sequence Id — response body — steps item
updatedAt	string	Required within parent	The date and time when the sequence was last updated, in ISO 8601 format. Format: date-time
userId	string	Required within parent	The unique identifier of the user who owns the sequence.

Referenced models: Update sequence — response body — settings, Update sequence — response body — dependencies item, Retrieve sequence — sequences get By Sequence Id — response body — steps item

Retrieve sequence — sequences get By Sequence Id — response body — steps item

Field	Type	Presence	Description and constraints
$	object	Root
actionType	string	Required within parent	The type of action to be performed in this step. Valid values include 'EMAIL', 'TASK', and 'FINISH_ENROLLMENT'. Known values: ADAPTIVE_CONTAINER, EMAIL, FINISH_ENROLLMENT, TASK
createdAt	string	Required within parent	The date and time when this step was created, in ISO 8601 format. Format: date-time
delayMillis	JSON	Required within parent
delayMillis (anyOf 1)	integer	Alternative	The delay before executing this step, specified in milliseconds as a 64-bit integer. Format: int64
delayMillis (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
emailPattern	Model	Optional	Expand Update sequence — response body — steps item email Pattern
id	string	Required within parent	The unique identifier for this sequence step, represented as a string.
stepOrder	JSON	Required within parent
stepOrder (anyOf 1)	integer	Alternative	An integer indicating the order of this step within the sequence. Format: int32
stepOrder (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
taskPattern	Model	Optional	Expand Retrieve sequence — sequences get By Sequence Id — response body — steps item task Pattern
updatedAt	string	Required within parent	The date and time when this step was last updated, in ISO 8601 format. Format: date-time

Referenced models: Update sequence — response body — steps item email Pattern, Retrieve sequence — sequences get By Sequence Id — response body — steps item task Pattern

Retrieve sequence — sequences get By Sequence Id — response body — steps item task Pattern

Field	Type	Presence	Description and constraints
$	object	Root
createdAt	string	Required within parent	The date and time when this task pattern was created, in ISO 8601 format. Format: date-time
id	string	Required within parent	The unique identifier for this task pattern.
notes	string	Optional	Additional notes related to the task, represented as a string.
queueId	JSON	Optional
queueId (anyOf 1)	integer	Alternative	An integer representing the ID of the queue to which this task belongs. Format: int32
queueId (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
subject	string	Optional	The subject of the task, represented as a string.
taskPriority	string	Required within parent	The priority level of the task, with valid values including 'NONE', 'HIGH', 'MEDIUM', and 'LOW'. Known values: HIGH, LOW, MEDIUM, NONE
taskType	string	Required within parent	The type of task, with valid values including 'CALL', 'MEETING', 'EMAIL', 'TODO', 'LINKED_IN_CONNECT', and 'LINKED_IN_MESSAGE'. Known values: CALL, EMAIL, LINKED_IN_CONNECT, LINKED_IN_MESSAGE, MEETING, TODO
templateId	JSON	Optional
templateId (anyOf 1)	integer	Alternative	An integer representing the ID of the template associated with this task. Format: int64
templateId (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
threadEmailToStepOrder	JSON	Optional
threadEmailToStepOrder (anyOf 1)	integer	Alternative	An integer indicating the step order to which this email task is threaded. Format: int32
threadEmailToStepOrder (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
updatedAt	string	Required within parent	The date and time when this task pattern was last updated, in ISO 8601 format. Format: date-time

Update sequence — response body

Field	Type	Presence	Description and constraints
$	object	Root
createdAt	string	Required within parent	The date and time when the sequence was created, in ISO 8601 format. Format: date-time
dependencies	array	Required within parent	An array of dependencies between steps in the sequence, each represented by a PublicSequenceStepDependencyResponse object.
dependencies[]	Model	Each item	Expand Update sequence — response body — dependencies item
folderId	string	Optional	The identifier for the folder containing the sequence.
id	string	Required within parent	The unique identifier for the sequence.
name	string	Required within parent	The name of the sequence.
settings	Model	Optional	Expand Update sequence — response body — settings
steps	array	Required within parent	An array of steps included in the sequence, each represented by a PublicSequenceStepResponseV2 object.
steps[]	Model	Each item	Expand Update sequence — response body — steps item
updatedAt	string	Required within parent	The date and time when the sequence was last updated, in ISO 8601 format. Format: date-time
userId	string	Required within parent	The unique identifier of the user who owns the sequence.

Referenced models: Update sequence — response body — settings, Update sequence — response body — dependencies item, Update sequence — response body — steps item

Update sequence — response body — dependencies item

Field	Type	Presence	Description and constraints
$	object	Root
createdAt	string	Required within parent	The date and time when this dependency was created, in ISO 8601 format. Format: date-time
dependencyType	string	Required within parent	The type of dependency, which can be either 'TASK_COMPLETION' or 'MANUAL_PAUSE'. Known values: ADAPTIVE_COMPLETION, MANUAL_PAUSE, TASK_COMPLETION
id	string	Required within parent	The unique identifier for this dependency.
reliesOnSequenceStepId	string	Required within parent	The unique identifier of the sequence step that this dependency relies on.
reliesOnStepOrder	JSON	Required within parent
reliesOnStepOrder (anyOf 1)	integer	Alternative	The order number of the step that this dependency relies on. Format: int32
reliesOnStepOrder (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
requiredBySequenceStepId	string	Required within parent	The unique identifier of the sequence step that requires this dependency.
requiredByStepOrder	JSON	Required within parent
requiredByStepOrder (anyOf 1)	integer	Alternative	The order number of the step that requires this dependency. Format: int32
requiredByStepOrder (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
updatedAt	string	Required within parent	The date and time when this dependency was last updated, in ISO 8601 format. Format: date-time

Update sequence — response body — settings

Field	Type	Presence	Description and constraints
$	object	Root
createdAt	string	Required within parent	The date and time when the sequence settings were created, in ISO 8601 format. Format: date-time
eligibleFollowUpDays	string	Required within parent	Specifies the days eligible for follow-ups. Valid values include 'EVERYDAY', 'BUSINESS_DAYS', and 'WEEKDAYS_ONLY'. Known values: BUSINESS_DAYS, EVERYDAY, WEEKDAYS_ONLY
id	string	Required within parent	The unique identifier for the sequence settings.
individualTaskRemindersEnabled	boolean	Required within parent	A boolean indicating whether individual task reminders are enabled.
sellingStrategy	string	Required within parent	The strategy used for selling, which can be either 'LEAD_BASED' or 'ACCOUNT_BASED'. Known values: ACCOUNT_BASED, LEAD_BASED
sendWindowEndMinute	JSON	Required within parent
sendWindowEndMinute (anyOf 1)	integer	Alternative	The ending minute of the window during which emails can be sent, represented as an integer. Format: int32
sendWindowEndMinute (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
sendWindowStartMinute	JSON	Required within parent
sendWindowStartMinute (anyOf 1)	integer	Alternative	The starting minute of the window during which emails can be sent, represented as an integer. Format: int32
sendWindowStartMinute (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
taskReminderMinute	JSON	Required within parent
taskReminderMinute (anyOf 1)	integer	Alternative	The minute at which task reminders are sent, represented as an integer. Format: int32
taskReminderMinute (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
updatedAt	string	Required within parent	The date and time when the sequence settings were last updated, in ISO 8601 format. Format: date-time

Update sequence — response body — steps item

Field	Type	Presence	Description and constraints
$	object	Root
actionType	string	Required within parent	The type of action to be performed in this step. Valid values include 'EMAIL', 'TASK', and 'FINISH_ENROLLMENT'. Known values: ADAPTIVE_CONTAINER, EMAIL, FINISH_ENROLLMENT, TASK
createdAt	string	Required within parent	The date and time when this step was created, in ISO 8601 format. Format: date-time
delayMillis	JSON	Required within parent
delayMillis (anyOf 1)	integer	Alternative	The delay before this step is executed, specified in milliseconds. Format: int64
delayMillis (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
emailPattern	Model	Optional	Expand Update sequence — response body — steps item email Pattern
id	string	Required within parent	The unique identifier for this sequence step.
stepOrder	JSON	Required within parent
stepOrder (anyOf 1)	integer	Alternative	An integer indicating the order of this step within the sequence. Format: int32
stepOrder (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
taskPattern	Model	Optional	Expand Update sequence — response body — steps item task Pattern
updatedAt	string	Required within parent	The date and time when this step was last updated, in ISO 8601 format. Format: date-time

Referenced models: Update sequence — response body — steps item email Pattern, Update sequence — response body — steps item task Pattern

Update sequence — response body — steps item email Pattern

Field	Type	Presence	Description and constraints
$	object	Root
createdAt	string	Required within parent	The date and time when this email pattern was created, in ISO 8601 format. Format: date-time
id	string	Required within parent	The unique identifier for this email pattern. It is a string.
templateId	string	Required within parent	The identifier of the email template associated with this pattern. It is a string.
threadEmailToStepOrder	JSON	Optional
threadEmailToStepOrder (anyOf 1)	integer	Alternative	An integer representing the order of the step to which this email pattern is threaded. Format: int32
threadEmailToStepOrder (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
updatedAt	string	Required within parent	The date and time when this email pattern was last updated, in ISO 8601 format. Format: date-time

Update sequence — response body — steps item task Pattern

Field	Type	Presence	Description and constraints
$	object	Root
createdAt	string	Required within parent	The date and time when this task pattern was created, in ISO 8601 format. Format: date-time
id	string	Required within parent	The unique identifier for this task pattern.
notes	string	Optional	Additional notes or description associated with the task.
queueId	string	Optional	The identifier for the queue to which this task belongs.
subject	string	Optional	The subject or title of the task.
taskPriority	string	Required within parent	The priority level of the task, with valid values being 'NONE', 'HIGH', 'MEDIUM', or 'LOW'. Known values: HIGH, LOW, MEDIUM, NONE
taskType	string	Required within parent	The type of task, which can be one of the following: 'CALL', 'MEETING', 'EMAIL', 'TODO', 'LINKED_IN_CONNECT', or 'LINKED_IN_MESSAGE'. Known values: CALL, EMAIL, LINKED_IN_CONNECT, LINKED_IN_MESSAGE, MEETING, TODO
templateId	string	Optional	The identifier for the template used in this task.
threadEmailToStepOrder	JSON	Optional
threadEmailToStepOrder (anyOf 1)	integer	Alternative	An integer representing the order of the step to which this email thread relates. Format: int32
threadEmailToStepOrder (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
updatedAt	string	Required within parent	The date and time when this task pattern was last updated, in ISO 8601 format. Format: date-time