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-03/links/generate

Request

  • Base URL
    https://api.hubapi.com
  • URL
    https://api.hubapi.com/communication-preferences/2026-03/links/generate
  • Auth
    • HTTP bearer
    • or API key in query parameter hapikey
    • or none

Query parameters

channel'EMAIL' required

The communication channel for which the links are generated. Must be 'EMAIL'.

businessUnitIdinteger

The identifier of the business unit. Defaults to 0 if not specified.

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

  • b0d8bc008db9Revision changes
    • info

      api operation id post-/communication-preferences/2026-03/links/generate_/communication-preferences/v4/links/generate removed and replaced with post-/communication-preferences/2026-03/links/generate

    • info

      the security scope communication_preferences.read was added to the endpoint's security scheme private_apps

    • info

      the security scope communication_preferences.write was added to the endpoint's security scheme private_apps

    • info

      the security scope communication_preferences.read_write was removed from the endpoint's security scheme private_apps

  • 3578967e48dfRevision changes
    • info

      the security scope communication_preferences.read was added to the endpoint's security scheme private_apps

    • info

      the security scope communication_preferences.write was added to the endpoint's security scheme private_apps

    • info

      the security scope communication_preferences.read_write was removed from the endpoint's security scheme private_apps

Some revisions have not been checked yet.