> ## Documentation Index
> Fetch the complete documentation index at: https://developers.hubspot.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.
# Update sequence
> Update an existing sequence in your HubSpot account using its unique identifier. This endpoint allows you to modify the sequence settings, steps, and dependencies. Ensure that the sequenceId provided in the path is valid and corresponds to the sequence you wish to update. Please note: the scopes for this endpoint requires user-level access and will not work for existing apps with portal-level access.
export const ScopesList = ({scopes = [], description = "This API requires one of the following scopes:"}) => {
if (!scopes || scopes.length === 0) {
return null;
}
const sortedScopes = scopes.sort((a, b) => a.localeCompare(b));
return
;
};
## OpenAPI
````yaml specs/2026-09-beta/automation-sequences-v2026-09-beta.json PUT /automation/sequences/2026-09-beta/serviceaccounts/sequences/{sequenceId}
openapi: 3.0.1
info:
title: Automation Sequences
description: Basepom for all HubSpot Projects
version: 2026-09-beta
x-hubspot-product-tier-requirements:
marketing: FREE
sales: FREE
service: FREE
cms: FREE
commerce: FREE
crmHub: FREE
dataHub: FREE
servers:
- url: https://api.hubapi.com
security: []
tags:
- name: Basic
- name: Enrollment
paths:
/automation/sequences/2026-09-beta/serviceaccounts/sequences/{sequenceId}:
put:
tags:
- Basic
summary: Update sequence
description: >-
Update an existing sequence in your HubSpot account using its unique
identifier. This endpoint allows you to modify the sequence settings,
steps, and dependencies. Ensure that the sequenceId provided in the path
is valid and corresponds to the sequence you wish to update. Please
note: the scopes for this endpoint requires user-level access and will
not work for existing apps with portal-level access.
operationId: >-
put-/automation/sequences/2026-09-beta/serviceaccounts/sequences/{sequenceId}
parameters:
- name: sequenceId
in: path
description: The unique identifier of the sequence to update.
required: true
style: simple
explode: false
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/PublicSequenceRequest'
required: true
responses:
'200':
description: successful operation
content:
application/json:
schema:
$ref: '#/components/schemas/PublicSequenceResponseV2'
default:
$ref: '#/components/responses/Error'
description: ''
security:
- oauth2:
- automation.sequences.write
components:
schemas:
PublicSequenceRequest:
required:
- dependencies
- dynamic
- name
- settings
- steps
type: object
properties:
dependencies:
type: array
description: >-
An array of dependencies between sequence steps, each defined by the
PublicSequenceStepDependencyRequest schema.
items:
$ref: '#/components/schemas/PublicSequenceStepDependencyRequest'
dynamic:
type: boolean
description: A boolean indicating whether the sequence is dynamic.
engagementTriggers:
$ref: '#/components/schemas/PublicSequenceEngagementTriggersRequest'
folderId:
type: string
description: >-
The identifier of the folder where the sequence is stored. It is a
string.
name:
type: string
description: The name of the sequence. It is a string.
settings:
$ref: '#/components/schemas/PublicSequenceSettingsRequest'
steps:
type: array
description: >-
An array of steps in the sequence, each defined by the
PublicSequenceStepRequest schema.
items:
$ref: '#/components/schemas/PublicSequenceStepRequest'
PublicSequenceResponseV2:
required:
- createdAt
- dependencies
- id
- name
- steps
- updatedAt
- userId
type: object
properties:
createdAt:
type: string
description: The date and time when the sequence was created, in ISO 8601 format.
format: date-time
dependencies:
type: array
description: >-
An array of dependencies between steps in the sequence, each
represented by a PublicSequenceStepDependencyResponse object.
items:
$ref: '#/components/schemas/PublicSequenceStepDependencyResponse'
folderId:
type: string
description: The identifier for the folder containing the sequence.
id:
type: string
description: The unique identifier for the sequence.
name:
type: string
description: The name of the sequence.
settings:
$ref: '#/components/schemas/PublicSequenceSettingsResponse'
steps:
type: array
description: >-
An array of steps included in the sequence, each represented by a
PublicSequenceStepResponseV2 object.
items:
$ref: '#/components/schemas/PublicSequenceStepResponseV2'
updatedAt:
type: string
description: >-
The date and time when the sequence was last updated, in ISO 8601
format.
format: date-time
userId:
type: string
description: The unique identifier of the user who owns the sequence.
PublicSequenceStepDependencyRequest:
required:
- branchNumber
- dependencyType
- reliesOnStepOrder
- requiredByStepOrder
type: object
properties:
branchNumber:
type: integer
description: >-
An integer indicating the branch number associated with the
dependency.
format: int32
dependencyType:
type: string
description: >-
A string indicating the type of dependency. Valid values include
'TASK_COMPLETION' and 'MANUAL_PAUSE'.
enum:
- ADAPTIVE_COMPLETION
- MANUAL_PAUSE
- TASK_COMPLETION
reliesOnStepOrder:
type: integer
description: >-
An integer representing the order of the step that is relied upon by
another step.
format: int32
requiredByStepOrder:
type: integer
description: >-
An integer representing the order of the step that requires the
dependency.
format: int32
PublicSequenceEngagementTriggersRequest:
type: object
properties:
numberOfClicks:
type: integer
description: >-
An integer representing the number of times links within an email
must be clicked to trigger an engagement action.
format: int32
numberOfOpens:
type: integer
description: >-
An integer representing the number of times an email must be opened
to trigger an engagement action.
format: int32
PublicSequenceSettingsRequest:
required:
- eligibleFollowUpDays
- individualTaskRemindersEnabled
- sellingStrategy
- sendWindowEndMinute
- sendWindowStartMinute
- taskCreationMinute
- taskReminderMinute
- unenrollmentSettings
- useThreadedFollowUps
type: object
properties:
eligibleFollowUpDays:
type: string
description: >-
Specifies the days on which follow-ups are eligible to be sent.
Valid values include 'EVERYDAY', 'BUSINESS_DAYS', and
'WEEKDAYS_ONLY'.
enum:
- BUSINESS_DAYS
- EVERYDAY
- WEEKDAYS_ONLY
individualTaskRemindersEnabled:
type: boolean
description: A boolean indicating whether individual task reminders are enabled.
sellingStrategy:
type: string
description: >-
Defines the selling strategy to be used. Valid values include
'LEAD_BASED' and 'ACCOUNT_BASED'.
enum:
- ACCOUNT_BASED
- LEAD_BASED
sendWindowEndMinute:
type: integer
description: >-
An integer representing the end minute of the window during which
emails can be sent.
format: int32
sendWindowStartMinute:
type: integer
description: >-
An integer representing the start minute of the window during which
emails can be sent.
format: int32
taskCreationMinute:
type: integer
description: An integer indicating the minute at which tasks should be created.
format: int32
taskReminderMinute:
type: integer
description: >-
An integer indicating the minute at which task reminders should be
sent.
format: int32
unenrollmentSettings:
$ref: '#/components/schemas/UnenrollmentSettingsResponse'
useThreadedFollowUps:
type: boolean
description: A boolean indicating whether follow-ups should be threaded.
PublicSequenceStepRequest:
required:
- actionType
- branchNumber
- delayMillis
- dynamic
- stepOrder
- variants
type: object
properties:
actionType:
type: string
description: >-
A string indicating the type of action to be performed in this step.
Valid values include 'EMAIL', 'TASK', and 'FINISH_ENROLLMENT'.
enum:
- ADAPTIVE_CONTAINER
- EMAIL
- FINISH_ENROLLMENT
- TASK
branchNumber:
type: integer
description: >-
An integer representing the branch number of this step, used for
branching logic in sequences.
format: int32
delayMillis:
type: integer
description: >-
An integer representing the delay in milliseconds before this step
is executed.
format: int64
delayMillisMax:
type: integer
description: >-
An integer specifying the maximum delay in milliseconds for this
step.
format: int64
delayMillisMin:
type: integer
description: >-
An integer specifying the minimum delay in milliseconds for this
step.
format: int64
dynamic:
type: boolean
description: >-
A boolean indicating whether the step is dynamic, allowing for
conditional execution based on certain criteria.
emailPattern:
$ref: '#/components/schemas/PublicSequenceEmailPatternRequest'
stepOrder:
type: integer
description: An integer indicating the order of the step within the sequence.
format: int32
taskPattern:
$ref: '#/components/schemas/PublicSequenceTaskPatternRequest'
variants:
type: array
description: >-
An array of PublicSequenceStepVariantRequest objects, each
representing a variant of this step.
items:
$ref: '#/components/schemas/PublicSequenceStepVariantRequest'
PublicSequenceStepDependencyResponse:
required:
- createdAt
- dependencyType
- id
- reliesOnSequenceStepId
- reliesOnStepOrder
- requiredBySequenceStepId
- requiredByStepOrder
- updatedAt
type: object
properties:
createdAt:
type: string
description: >-
The date and time when this dependency was created, in ISO 8601
format.
format: date-time
dependencyType:
type: string
description: >-
The type of dependency, which can be either 'TASK_COMPLETION' or
'MANUAL_PAUSE'.
enum:
- ADAPTIVE_COMPLETION
- MANUAL_PAUSE
- TASK_COMPLETION
id:
type: string
description: The unique identifier for this dependency.
reliesOnSequenceStepId:
type: string
description: >-
The unique identifier of the sequence step that this dependency
relies on.
reliesOnStepOrder:
type: integer
description: The order number of the step that this dependency relies on.
format: int32
requiredBySequenceStepId:
type: string
description: >-
The unique identifier of the sequence step that requires this
dependency.
requiredByStepOrder:
type: integer
description: The order number of the step that requires this dependency.
format: int32
updatedAt:
type: string
description: >-
The date and time when this dependency was last updated, in ISO 8601
format.
format: date-time
PublicSequenceSettingsResponse:
required:
- createdAt
- eligibleFollowUpDays
- id
- individualTaskRemindersEnabled
- sellingStrategy
- sendWindowEndMinute
- sendWindowStartMinute
- taskReminderMinute
- updatedAt
type: object
properties:
createdAt:
type: string
description: >-
The date and time when the sequence settings were created, in ISO
8601 format.
format: date-time
eligibleFollowUpDays:
type: string
description: >-
Specifies the days eligible for follow-ups. Valid values include
'EVERYDAY', 'BUSINESS_DAYS', and 'WEEKDAYS_ONLY'.
enum:
- BUSINESS_DAYS
- EVERYDAY
- WEEKDAYS_ONLY
id:
type: string
description: The unique identifier for the sequence settings.
individualTaskRemindersEnabled:
type: boolean
description: A boolean indicating whether individual task reminders are enabled.
sellingStrategy:
type: string
description: >-
The strategy used for selling, which can be either 'LEAD_BASED' or
'ACCOUNT_BASED'.
enum:
- ACCOUNT_BASED
- LEAD_BASED
sendWindowEndMinute:
type: integer
description: >-
The ending minute of the window during which emails can be sent,
represented as an integer.
format: int32
sendWindowStartMinute:
type: integer
description: >-
The starting minute of the window during which emails can be sent,
represented as an integer.
format: int32
taskReminderMinute:
type: integer
description: >-
The minute at which task reminders are sent, represented as an
integer.
format: int32
updatedAt:
type: string
description: >-
The date and time when the sequence settings were last updated, in
ISO 8601 format.
format: date-time
PublicSequenceStepResponseV2:
required:
- actionType
- createdAt
- delayMillis
- id
- stepOrder
- updatedAt
type: object
properties:
actionType:
type: string
description: >-
The type of action to be performed in this step. Valid values
include 'EMAIL', 'TASK', and 'FINISH_ENROLLMENT'.
enum:
- ADAPTIVE_CONTAINER
- EMAIL
- FINISH_ENROLLMENT
- TASK
createdAt:
type: string
description: The date and time when this step was created, in ISO 8601 format.
format: date-time
delayMillis:
type: integer
description: The delay before this step is executed, specified in milliseconds.
format: int64
emailPattern:
$ref: '#/components/schemas/PublicEmailPatternResponse'
id:
type: string
description: The unique identifier for this sequence step.
stepOrder:
type: integer
description: An integer indicating the order of this step within the sequence.
format: int32
taskPattern:
$ref: '#/components/schemas/PublicTaskPatternResponseV2'
updatedAt:
type: string
description: >-
The date and time when this step was last updated, in ISO 8601
format.
format: date-time
Error:
required:
- category
- correlationId
- message
type: object
properties:
category:
type: string
description: >-
The error category, indicating the general type of error that
occurred.
context:
type: object
additionalProperties:
type: array
items:
type: string
description: >-
Context about the error condition, represented as an object with
additional properties that are arrays of strings.
example: >-
{invalidPropertyName=[propertyValue], missingScopes=[scope1,
scope2]}
correlationId:
type: string
description: >-
A unique identifier for the request. Include this value with any
error reports or support tickets. It is formatted as a UUID.
format: uuid
example: aeb5f871-7f07-4993-9211-075dc63e7cbf
errors:
type: array
description: >-
Further information about the error, represented as an array of
ErrorDetail objects.
items:
$ref: '#/components/schemas/ErrorDetail'
links:
type: object
additionalProperties:
type: string
description: >-
A map of link names to associated URIs containing documentation
about the error or recommended remediation steps.
message:
type: string
description: >-
A human readable message describing the error along with remediation
steps where appropriate.
example: An error occurred
subCategory:
type: string
description: >-
A specific category that contains more specific detail about the
error.
example:
message: Invalid input (details will vary based on the error)
correlationId: aeb5f871-7f07-4993-9211-075dc63e7cbf
category: VALIDATION_ERROR
links:
knowledge-base: https://www.hubspot.com/products/service/knowledge-base
UnenrollmentSettingsResponse:
required:
- emailSettings
- meetingSettings
type: object
properties:
emailSettings:
$ref: '#/components/schemas/EmailSettingsResponse'
meetingSettings:
$ref: '#/components/schemas/MeetingSettingsResponse'
PublicSequenceEmailPatternRequest:
required:
- templateId
type: object
properties:
templateId:
type: string
description: >-
The unique identifier for the email template to be used. It is a
string and is required.
threadEmailToStepOrder:
type: integer
description: >-
An integer indicating the step order to which the email should be
threaded. This property is optional.
format: int32
PublicSequenceTaskPatternRequest:
required:
- taskPriority
- taskType
type: object
properties:
notes:
type: string
description: A string containing additional notes or details about the task.
queueId:
type: string
description: A string identifier for the queue to which the task belongs.
subject:
type: string
description: A string representing the subject of the task.
taskPriority:
type: string
description: >-
The priority level of the task. Valid values include 'NONE', 'HIGH',
'MEDIUM', and 'LOW'.
enum:
- HIGH
- LOW
- MEDIUM
- NONE
taskType:
type: string
description: >-
The type of task to be performed. Valid values include 'CALL',
'MEETING', 'EMAIL', 'TODO', 'LINKED_IN_CONNECT', and
'LINKED_IN_MESSAGE'.
enum:
- CALL
- EMAIL
- LINKED_IN_CONNECT
- LINKED_IN_MESSAGE
- MEETING
- TODO
templateId:
type: string
description: A string identifier for the template associated with the task.
threadEmailToStepOrder:
type: integer
description: >-
An integer representing the order of the step to which the email
should be threaded.
format: int32
PublicSequenceStepVariantRequest:
required:
- activated
- variantOrdinal
type: object
properties:
activated:
type: boolean
description: A boolean indicating whether this variant is active.
emailPattern:
$ref: '#/components/schemas/PublicSequenceEmailPatternRequest'
taskPattern:
$ref: '#/components/schemas/PublicSequenceTaskPatternRequest'
variantOrdinal:
type: integer
description: >-
An integer indicating the order of this variant among other variants
of the same step.
format: int32
PublicEmailPatternResponse:
required:
- createdAt
- id
- templateId
- updatedAt
type: object
properties:
createdAt:
type: string
description: >-
The date and time when this email pattern was created, in ISO 8601
format.
format: date-time
id:
type: string
description: The unique identifier for this email pattern. It is a string.
templateId:
type: string
description: >-
The identifier of the email template associated with this pattern.
It is a string.
threadEmailToStepOrder:
type: integer
description: >-
An integer representing the order of the step to which this email
pattern is threaded.
format: int32
updatedAt:
type: string
description: >-
The date and time when this email pattern was last updated, in ISO
8601 format.
format: date-time
PublicTaskPatternResponseV2:
required:
- createdAt
- id
- taskPriority
- taskType
- updatedAt
type: object
properties:
createdAt:
type: string
description: >-
The date and time when this task pattern was created, in ISO 8601
format.
format: date-time
id:
type: string
description: The unique identifier for this task pattern.
notes:
type: string
description: Additional notes or description associated with the task.
queueId:
type: string
description: The identifier for the queue to which this task belongs.
subject:
type: string
description: The subject or title of the task.
taskPriority:
type: string
description: >-
The priority level of the task, with valid values being 'NONE',
'HIGH', 'MEDIUM', or 'LOW'.
enum:
- HIGH
- LOW
- MEDIUM
- NONE
taskType:
type: string
description: >-
The type of task, which can be one of the following: 'CALL',
'MEETING', 'EMAIL', 'TODO', 'LINKED_IN_CONNECT', or
'LINKED_IN_MESSAGE'.
enum:
- CALL
- EMAIL
- LINKED_IN_CONNECT
- LINKED_IN_MESSAGE
- MEETING
- TODO
templateId:
type: string
description: The identifier for the template used in this task.
threadEmailToStepOrder:
type: integer
description: >-
An integer representing the order of the step to which this email
thread relates.
format: int32
updatedAt:
type: string
description: >-
The date and time when this task pattern was last updated, in ISO
8601 format.
format: date-time
ErrorDetail:
required:
- message
type: object
properties:
code:
type: string
description: >-
The status code associated with the error detail, indicating the
type of error encountered.
context:
type: object
additionalProperties:
type: array
items:
type: string
description: >-
Context about the error condition, provided as an object with
additional properties. This can include specific details such as
missing scopes.
example: '{missingScopes=[scope1, scope2]}'
in:
type: string
description: >-
The name of the field or parameter in which the error was found.
This provides context about where the error occurred.
message:
type: string
description: >-
A human readable message describing the error along with remediation
steps where appropriate. This is a required field.
subCategory:
type: string
description: >-
A specific category that contains more specific detail about the
error, helping to further classify the error.
EmailSettingsResponse:
required:
- criteria
- sellingStrategy
type: object
properties:
criteria:
type: string
description: >-
A string representing the criteria for email settings. Valid values
include 'ALL' and 'NONE'.
enum:
- ALL
- NONE
sellingStrategy:
type: string
description: >-
A string indicating the selling strategy for email settings. Valid
values are 'LEAD_BASED' and 'ACCOUNT_BASED'.
enum:
- ACCOUNT_BASED
- LEAD_BASED
MeetingSettingsResponse:
required:
- criteria
- sellingStrategy
type: object
properties:
criteria:
type: string
description: >-
Specifies the criteria for meetings, with valid values being 'ALL'
or 'NONE'.
enum:
- ALL
- NONE
sellingStrategy:
type: string
description: >-
Indicates the selling strategy employed, which can be either
'LEAD_BASED' or 'ACCOUNT_BASED'.
enum:
- ACCOUNT_BASED
- LEAD_BASED
responses:
Error:
description: An error occurred.
content:
'*/*':
schema:
$ref: '#/components/schemas/Error'
securitySchemes:
oauth2:
type: oauth2
flows:
authorizationCode:
authorizationUrl: https://app.hubspot.com/oauth/authorize
tokenUrl: https://api.hubapi.com/oauth/v1/token
scopes:
automation.sequences.enrollments.write: ''
automation.sequences.read: ''
automation.sequences.write: ''
sequences-public-delete: ''
````
{product.name} -
{product.level}
)}