Basic

Upsert Subscription

Changed on

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.

post/webhooks-journal/subscriptions/2027-03-beta

Request

  • Base URL
    https://api.hubapi.com
  • URL
    https://api.hubapi.com/webhooks-journal/subscriptions/2027-03-beta
  • Auth
    none required

Request body

OR
OR
OR
OR

Response

successful operation

actionOverridesobject
actionsstring[] required
appIdinteger required
associatedObjectTypeIdsstring[]
createdAtstring date-time required
createdByinteger
deletedAtstring date-time
idinteger required
includeSensitivePropertiesChangedboolean
listIdsinteger[]
objectIdsinteger[]
objectTypeIdstring required
portalIdinteger
propertiesstring[]
subscriptionType'APP_LIFECYCLE_EVENT' | 'ASSOCIATION' | 'EVENT' | 'GDPR_PRIVACY_DELETION' | 'LIST_MEMBERSHIP' | 'OBJECT' required
updatedAtstring date-time required

Changes

  • 2027-03-beta83a9e3606e9fRevision changes
    • breaking

      removed from the request body oneOf list

    • info

      added to the request body oneOf list

    • info

      added the optional property to the response with the status

  • 2027-03-beta6995629a4549Revision changes
    • info

      the endpoint scheme security oauth2 was removed from the API