> ## 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.
# Batch create event subscriptions
> Batch create event subscriptions for the specified app.
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/webhooks-webhooks-v2026-09.json POST /app-webhooks/2026-09/{appId}/subscriptions/batch/update
openapi: 3.0.1
info:
title: Webhooks Webhooks
description: Basepom for all HubSpot Projects
version: 2026-09
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: Advanced
- name: Basic
- name: Batch
paths:
/app-webhooks/2026-09/{appId}/subscriptions/batch/update:
post:
tags:
- Batch
summary: Batch create event subscriptions
description: Batch create event subscriptions for the specified app.
operationId: >-
post-/app-webhooks/2026-09/{appId}/subscriptions/batch/update_updateBatch
parameters:
- name: appId
in: path
description: ''
required: true
style: simple
explode: false
schema:
type: integer
format: int32
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/BatchInputSubscriptionBatchUpdateRequest'
required: true
responses:
'200':
description: successful operation
content:
application/json:
schema:
$ref: '#/components/schemas/BatchResponseSubscriptionResponse'
'207':
description: multiple statuses
content:
application/json:
schema:
$ref: >-
#/components/schemas/BatchResponseSubscriptionResponseWithErrors
default:
$ref: '#/components/responses/Error'
description: ''
security:
- oauth2:
- developers-write
- oauth2:
- private-apps-write
components:
schemas:
BatchInputSubscriptionBatchUpdateRequest:
required:
- inputs
type: object
properties:
inputs:
type: array
description: >-
An array of SubscriptionBatchUpdateRequest objects, each
representing a subscription to be updated. This property is
required.
items:
$ref: '#/components/schemas/SubscriptionBatchUpdateRequest'
BatchResponseSubscriptionResponse:
required:
- completedAt
- results
- startedAt
- status
type: object
properties:
completedAt:
type: string
description: >-
The date and time when the batch operation was completed, in ISO
8601 format.
format: date-time
links:
type: object
additionalProperties:
type: string
description: >-
A map of link names to associated URIs providing additional
information about the batch operation.
requestedAt:
type: string
description: >-
The date and time when the batch operation was requested, in ISO
8601 format.
format: date-time
results:
type: array
description: >-
An array containing the results of the batch operation, with each
item representing an individual subscription response.
items:
$ref: '#/components/schemas/SubscriptionResponse'
startedAt:
type: string
description: >-
The date and time when the batch operation started, in ISO 8601
format.
format: date-time
status:
type: string
description: >-
The current status of the batch operation. Valid values include
'PENDING', 'PROCESSING', 'CANCELED', and 'COMPLETE'.
enum:
- CANCELED
- COMPLETE
- PENDING
- PROCESSING
BatchResponseSubscriptionResponseWithErrors:
required:
- completedAt
- results
- startedAt
- status
type: object
properties:
completedAt:
type: string
description: >-
The date and time when the batch processing was completed, in ISO
8601 format.
format: date-time
errors:
type: array
description: >-
An array of StandardError objects detailing any errors that occurred
during the batch processing.
items:
$ref: '#/components/schemas/StandardError'
links:
type: object
additionalProperties:
type: string
description: >-
A map of link names to associated URIs, providing additional
resources or documentation related to the batch operation.
numErrors:
type: integer
description: The total number of errors encountered during the batch operation.
format: int32
requestedAt:
type: string
description: >-
The date and time when the batch request was initially made, in ISO
8601 format.
format: date-time
results:
type: array
description: >-
An array of SubscriptionResponse objects representing the results of
each subscription update processed in the batch.
items:
$ref: '#/components/schemas/SubscriptionResponse'
startedAt:
type: string
description: >-
The date and time when the batch processing began, in ISO 8601
format.
format: date-time
status:
type: string
description: >-
The current status of the batch operation. Valid values include
'PENDING', 'PROCESSING', 'CANCELED', and 'COMPLETE'.
enum:
- CANCELED
- COMPLETE
- PENDING
- PROCESSING
SubscriptionBatchUpdateRequest:
required:
- active
- id
type: object
properties:
active:
type: boolean
description: A boolean indicating whether the subscription is active.
id:
type: integer
description: The unique identifier for the subscription. It is an integer.
format: int32
SubscriptionResponse:
required:
- active
- createdAt
- eventType
- id
type: object
properties:
active:
type: boolean
description: A boolean indicating whether the subscription is currently active.
createdAt:
type: string
description: >-
The date and time when the subscription was created, in ISO 8601
format.
format: date-time
eventType:
type: string
description: >-
The type of event that triggers the subscription. Valid values
include various property changes, creations, deletions, merges,
restores, and association changes for different HubSpot objects.
enum:
- company.associationChange
- company.creation
- company.deletion
- company.merge
- company.propertyChange
- company.restore
- contact.associationChange
- contact.creation
- contact.deletion
- contact.merge
- contact.privacyDeletion
- contact.propertyChange
- contact.restore
- conversation.creation
- conversation.deletion
- conversation.newMessage
- conversation.privacyDeletion
- conversation.propertyChange
- deal.associationChange
- deal.creation
- deal.deletion
- deal.merge
- deal.propertyChange
- deal.restore
- event.completed
- line_item.associationChange
- line_item.creation
- line_item.deletion
- line_item.merge
- line_item.propertyChange
- line_item.restore
- object.associationChange
- object.creation
- object.deletion
- object.merge
- object.propertyChange
- object.restore
- product.creation
- product.deletion
- product.merge
- product.propertyChange
- product.restore
- ticket.associationChange
- ticket.creation
- ticket.deletion
- ticket.merge
- ticket.propertyChange
- ticket.restore
eventTypeName:
type: string
description: The name of the event type for the subscription.
id:
type: string
description: >-
The unique identifier for the subscription. It is an integer
formatted as int64.
objectTypeId:
type: string
description: >-
The identifier for the object type associated with the subscription.
It is a string.
propertyName:
type: string
description: >-
The name of the property associated with the subscription event, if
applicable.
updatedAt:
type: string
description: >-
The date and time when the subscription was last updated, in ISO
8601 format.
format: date-time
StandardError:
required:
- category
- context
- errors
- links
- message
- status
type: object
properties:
category:
type: string
description: A string indicating the category of the error.
context:
type: object
additionalProperties:
type: array
items:
type: string
description: >-
An object containing additional context about the error condition,
with each property being an array of strings.
errors:
type: array
description: >-
An array of ErrorDetail objects providing further information about
the error.
items:
$ref: '#/components/schemas/ErrorDetail'
id:
type: string
description: A string that uniquely identifies the error instance.
links:
type: object
additionalProperties:
type: string
description: >-
An object mapping link names to associated URIs that contain
documentation about the error or recommended remediation steps.
message:
type: string
description: A string containing a human-readable message describing the error.
status:
type: string
description: A string representing the status of the error.
subCategory:
type: object
properties: {}
description: An object providing more specific categorization of the error.
description: Ye olde error
Error:
required:
- category
- correlationId
- message
type: object
properties:
category:
type: string
description: The error category
context:
type: object
additionalProperties:
type: array
items:
type: string
description: Context about the error condition
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
format: uuid
example: aeb5f871-7f07-4993-9211-075dc63e7cbf
errors:
type: array
description: further information about the error
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
description: >-
Represents an error response returned by the API when an operation
fails. This component is used in various endpoints to provide detailed
information about the error encountered.
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
ErrorDetail:
required:
- message
type: object
properties:
code:
type: string
description: The status code associated with the error detail
context:
type: object
additionalProperties:
type: array
items:
type: string
description: Context about the error condition
example: '{missingScopes=[scope1, scope2]}'
in:
type: string
description: The name of the field or parameter in which the error was found.
message:
type: string
description: >-
A human readable message describing the error along with remediation
steps where appropriate
subCategory:
type: string
description: >-
A specific category that contains more specific detail about the
error
description: >-
Represents detailed information about an error that occurred in the API.
This component is used to provide additional context and specifics about
errors, typically as part of an error response.
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:
developers-read: ''
developers-write: ''
private-apps-read: ''
private-apps-write: ''
webhooks-journal-data-access: ''
webhooks-journal-snapshot-management: ''
webhooks-journal-subscription-management: ''
webhooks-journal-subscription-read: ''
````
{product.name} -
{product.level}
)}