{
"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"
}
}
Subscriptions
Create or update a subscription
Create or update an existing subscription by specifying the fields and shapes of what events you need to listen to. Full documentation on potential subscription types can be found on the overview documentation page.
{
"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"
}
}
Supported products
Body
application/json
Option 1
Option 2
Option 3
Option 4
Option 5
actions
enum<string>[]
required
An array of strings specifying the actions that trigger the subscription. Valid actions include 'CREATE', 'UPDATE', 'DELETE', 'MERGE', 'RESTORE'.
Available options:
CREATE,
UPDATE,
DELETE,
MERGE,
RESTORE,
ASSOCIATION_ADDED,
ASSOCIATION_REMOVED,
SNAPSHOT,
APP_INSTALL,
APP_UNINSTALL,
ADDED_TO_LIST,
REMOVED_FROM_LIST,
GDPR_DELETE
objectIds
integer<int64>[]
required
An array of integers representing the IDs of the objects involved in the subscription. Empty means listen to all objectIds.
objectTypeId
string
required
A string that identifies the type of object for which the subscription is being created or updated. For example "0-1" for contacts.
portalId
integer<int64>
required
An integer representing the portal ID associated with the subscription.
properties
string[]
required
An array of strings listing the properties of the objects that are relevant to the subscription. Empty means listen to all properties.
subscriptionType
enum<string>
default:OBJECT
required
A string indicating the type of subscription. The default and only valid value is 'OBJECT'.
Available options:
OBJECT
Response
successful operation
actions
enum<string>[]
required
A list of actions that trigger the subscription. Possible values include 'CREATE', 'UPDATE', 'DELETE', 'MERGE', 'RESTORE', 'ASSOCIATION_ADDED', 'ASSOCIATION_REMOVED', 'SNAPSHOT', 'APP_INSTALL', 'APP_UNINSTALL', 'ADDED_TO_LIST', 'REMOVED_FROM_LIST', and 'GDPR_DELETE'.
Available options:
CREATE,
UPDATE,
DELETE,
MERGE,
RESTORE,
ASSOCIATION_ADDED,
ASSOCIATION_REMOVED,
SNAPSHOT,
APP_INSTALL,
APP_UNINSTALL,
ADDED_TO_LIST,
REMOVED_FROM_LIST,
GDPR_DELETE
appId
integer<int64>
required
The unique identifier for the app associated with the subscription. It is an integer formatted as int64.
createdAt
string<date-time>
required
The date and time when the subscription was created, in ISO 8601 format.
id
integer<int64>
required
The unique identifier for the subscription. It is an integer formatted as int64.
objectTypeId
string
required
The identifier for the object type associated with the subscription. It is a string.
subscriptionType
enum<string>
required
The type of subscription, which can be one of the following: 'OBJECT', 'ASSOCIATION', 'EVENT', 'APP_LIFECYCLE_EVENT', 'LIST_MEMBERSHIP', or 'GDPR_PRIVACY_DELETION'.
Available options:
APP_LIFECYCLE_EVENT,
ASSOCIATION,
EVENT,
GDPR_PRIVACY_DELETION,
LIST_MEMBERSHIP,
OBJECT
updatedAt
string<date-time>
required
The date and time when the subscription was last updated, in ISO 8601 format.
actionOverrides
object
An object containing action overrides, where each key is an action and the value is an ActionOverrideRequest object.
Show child attributes
associatedObjectTypeIds
string[]
A list of associated object type IDs. Each ID is a string.
createdBy
integer<int64>
The ID of the user who created the subscription. It is an integer formatted as int64.
deletedAt
string<date-time>
The date and time when the subscription was deleted, in ISO 8601 format, if applicable.
listIds
integer<int64>[]
A list of list IDs associated with the subscription. Each ID is an integer formatted as int64.
objectIds
integer<int64>[]
A list of object IDs associated with the subscription. Each ID is an integer formatted as int64.
portalId
integer<int64>
The unique identifier for the portal associated with the subscription. It is an integer formatted as int64.
properties
string[]
A list of property names associated with the subscription. Each property is a string.
Last modified on September 9, 2026
Was this page helpful?
Assistant
Responses are generated using AI and may contain mistakes.