curl --request POST \
--url https://api.hubapi.com/communication-preferences/2026-03/links/generate \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"subscriberIdString": "<string>",
"language": "<string>",
"subscriptionId": 123
}
'{
"managePreferencesUrl": "<string>",
"subscriberIdString": "<string>",
"unsubscribeAllUrl": "<string>",
"unsubscribeSingleUrl": "<string>"
}Generate subscription links
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.
curl --request POST \
--url https://api.hubapi.com/communication-preferences/2026-03/links/generate \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"subscriberIdString": "<string>",
"language": "<string>",
"subscriptionId": 123
}
'{
"managePreferencesUrl": "<string>",
"subscriberIdString": "<string>",
"unsubscribeAllUrl": "<string>",
"unsubscribeSingleUrl": "<string>"
}Supported products
Supported products
Required Scopes
Required Scopes
Authorizations
The access token received from the authorization server in the OAuth 2.0 flow.
Query Parameters
EMAIL Body
A string representing the unique identifier of the subscriber. This property is required.
The language in which the generated link should be presented, represented as a string.
The unique identifier for the subscription, represented as an integer in int64 format.
Response
successful operation
The URL where the subscriber can manage their communication preferences.
A string representing the unique identifier of the subscriber.
A string containing the URL for unsubscribing the subscriber from all communications.
A string containing the URL to unsubscribe the subscriber from a single communication.
Was this page helpful?