HUhubspot
Status

Generate subscription links

Changed on

Generate communication preference links for a subscriber. This endpoint allows you to create URLs for managing preferences and unsubscribing, tailored to a specific subscriber. It is useful for integrating communication preference management into your applications.

post/communication-preferences/2026-09/links/generate

Request

  • Base URL
    https://api.hubapi.com
  • URL
    https://api.hubapi.com/communication-preferences/2026-09/links/generate
  • Auth
    OAuth 2
    Authorization code: https://app.hubspot.com/oauth/authorize
    Token URL: https://api.hubapi.com/oauth/v1/token scopes: communication_preferences.read_write

Query parameters

channel'EMAIL' required

The communication channel for which the links are generated. Currently, only 'EMAIL' is supported.

businessUnitIdinteger

The ID of the business unit for which the links are generated. It is an optional parameter and defaults to 0.

Request body

languagestring

The language in which the generated link should be presented, represented as a string.

subscriberIdStringstring required

A string representing the unique identifier of the subscriber. This property is required.

subscriptionIdinteger

The unique identifier for the subscription, represented as an integer in int64 format.

Response

successful operation

managePreferencesUrlstring required

The URL where the subscriber can manage their communication preferences.

subscriberIdStringstring required

A string representing the unique identifier of the subscriber.

unsubscribeAllUrlstring required

A string containing the URL for unsubscribing the subscriber from all communications.

unsubscribeSingleUrlstring

A string containing the URL to unsubscribe the subscriber from a single communication.

Changes

  • 2026-09e1706f57adc0Revision changes
    • info

      the endpoint scheme security private_apps was removed from the API

    • info

      the endpoint scheme security private_apps was removed from the API

    • info

      the security scope communication_preferences.read_write was added to the endpoint's security scheme oauth2

    • info

      the security scope communication_preferences.read was removed from the endpoint's security scheme oauth2

    • info

      the security scope communication_preferences.write was removed from the endpoint's security scheme oauth2

    • info

      api tag Status added

    • info

      api tag Advanced removed