Skip to main content
POST
Upsert subscription

Supported products

Body

application/json
actions
enum<string>[]
required

An array of strings specifying the actions that trigger the subscription. Valid actions 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
objectIds
integer<int64>[]
required

An array of integers specifying the unique identifiers of the objects involved in the subscription.

objectTypeId
string
required

A string representing the unique identifier of the object type for which the subscription is being created or updated.

portalId
integer<int64>
required

An integer representing the unique identifier of the HubSpot portal.

properties
string[]
required

An array of strings listing the properties of the objects that are relevant to the subscription.

subscriptionType
enum<string>
default:OBJECT
required

A string indicating the type of subscription, which is always 'OBJECT' for this request.

Available options:
OBJECT

Response

successful operation

actions
enum<string>[]
required

An array of actions associated with the subscription. Valid actions 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, represented as an integer.

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, represented as an integer.

objectTypeId
string
required

The identifier for the type of object associated with the subscription, represented as a string.

subscriptionType
enum<string>
required

The type of subscription, indicating the nature of events it pertains to. Valid values include 'OBJECT', 'ASSOCIATION', 'EVENT', 'APP_LIFECYCLE_EVENT', 'LIST_MEMBERSHIP', and '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 overrides for actions, where each key is an action and the value is an ActionOverrideRequest object.

associatedObjectTypeIds
string[]

An array of strings representing the IDs of associated object types.

createdBy
integer<int64>

The unique identifier of the user who created the subscription, represented as an integer.

deletedAt
string<date-time>

The date and time when the subscription was deleted, in ISO 8601 format, if applicable.

listIds
integer<int64>[]

An array of integers representing the IDs of lists associated with the subscription.

objectIds
integer<int64>[]

An array of integers representing the IDs of objects associated with the subscription.

portalId
integer<int64>

The unique identifier for the portal associated with the subscription, represented as an integer.

properties
string[]

An array of strings representing the properties associated with the subscription.

Last modified on September 9, 2026