---
title: "Generate subscription links"
method: POST
path: "/communication-preferences/2026-03/links/generate"
tags: ["Status"]
---

# Generate subscription links

`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: one of:
  - HTTP bearer
  - API key in query parameter `hapikey`
  - none

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.

## Query parameters

- `channel` 'EMAIL', required
- `businessUnitId` integer

## Request body

- CommunicationPreferencesLinkGenerationRequest
  - `language` string: The language in which the generated link should be presented, represented as a string.
  - `subscriberIdString` string, required: A string representing the unique identifier of the subscriber. This property is required.
  - `subscriptionId` integer: The unique identifier for the subscription, represented as an integer in int64 format.

## Response `200`

successful operation

- CommunicationPreferencesLinkGenerationResponse
  - `managePreferencesUrl` string, required: The URL where the subscriber can manage their communication preferences.
  - `subscriberIdString` string, required: A string representing the unique identifier of the subscriber.
  - `unsubscribeAllUrl` string, required: A string containing the URL for unsubscribing the subscriber from all communications.
  - `unsubscribeSingleUrl` string: A string containing the URL to unsubscribe the subscriber from a single communication.

## Other responses

- `default`: An error occurred.

## Changes

> 14 revisions in range; 1 not diffed, 2 could not be searched.

- **2026-04-08** `b0d8bc008db9`: 4 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`
  - the security scope `communication_preferences.read` was added to the endpoint's security scheme `private_apps`
  - the security scope `communication_preferences.write` was added to the endpoint's security scheme `private_apps`
  - the security scope `communication_preferences.read_write` was removed from the endpoint's security scheme `private_apps`
- **2026-04-03** `3578967e48df`: 3 info
  - the security scope `communication_preferences.read` was added to the endpoint's security scheme `private_apps`
  - the security scope `communication_preferences.write` was added to the endpoint's security scheme `private_apps`
  - the security scope `communication_preferences.read_write` was removed from the endpoint's security scheme `private_apps`
- **2026-04-01** `e0403341222c`: 3 info
  - the security scope `communication_preferences.read` was added to the endpoint's security scheme `private_apps`
  - the security scope `communication_preferences.write` was added to the endpoint's security scheme `private_apps`
  - the security scope `communication_preferences.read_write` was removed from the endpoint's security scheme `private_apps`
- …earlier changes not shown

[Operation history](https://skmtc.dev/hubspot/apis/hubspot-api-specification/changes/communication-preferences/2026-03/links/generate/post.md)

---

[API](https://skmtc.dev/hubspot/apis/hubspot-api-specification.md) - [All operations](https://skmtc.dev/hubspot/apis/hubspot-api-specification/llms.txt) - [OpenAPI document](https://skmtc.dev/hubspot/apis/hubspot-api-specification/revisions/f9c7181056c5?raw)
